Skip to content

Latest commit

 

History

History
67 lines (42 loc) · 2.11 KB

README.md

File metadata and controls

67 lines (42 loc) · 2.11 KB
Raw

ImageFlux

Gem CircleCI Coverage Status

URL builder for ImageFlux®.

WIP: Provide API client

Installation

Add this line to your application's Gemfile:

gem 'image_flux'

And then execute:

$ bundle

Or install it yourself as:

$ gem install image_flux

Usage

Generate resize url for a path

require 'image_flux'
origin = ImageFlux::Origin.new(domain: 'example.imageflux.jp')

origin.image_url('/original.jpg', width: 100)
# => https://example.imageflux.jp/c/w=100/original.jpg

Generate option with class

option = ImageFlux::Option.new()
option.width = 100
option.overlay = [
  { w: 100, path: '/hello-world.png' },
]
origin.image_url('/original.jpg', option)

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/space-pirates-llc/image_flux.

License

The gem is available as open source under the terms of the MIT License.

Notation

  • ImageFlux is a registered trademark of SAKURA Internet Inc..
  • Regarding the use of this gem, pixiv Inc. and SAKURA Internet Inc. makes no responsibility.