Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/space-pirates-llc/image_flux
URL builder for ImageFlux
https://github.com/space-pirates-llc/image_flux
imageflux ruby rubygem
Last synced: 20 days ago
JSON representation
URL builder for ImageFlux
- Host: GitHub
- URL: https://github.com/space-pirates-llc/image_flux
- Owner: space-pirates-llc
- License: mit
- Created: 2017-11-30T07:23:42.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-07T13:55:56.000Z (almost 3 years ago)
- Last Synced: 2024-12-08T19:33:59.531Z (about 1 month ago)
- Topics: imageflux, ruby, rubygem
- Language: Ruby
- Homepage:
- Size: 44.9 KB
- Stars: 8
- Watchers: 8
- Forks: 6
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# ImageFlux
[![Gem](https://img.shields.io/gem/v/image_flux.svg)](https://rubygems.org/gems/image_flux)
[![CircleCI](https://img.shields.io/circleci/project/github/space-pirates-llc/image_flux.svg)](https://circleci.com/gh/space-pirates-llc/image_flux)
[![Coverage Status](https://coveralls.io/repos/github/space-pirates-llc/image_flux/badge.svg?branch=master)](https://coveralls.io/github/space-pirates-llc/image_flux?branch=master)URL builder for [ImageFlux](https://www.sakura.ad.jp/services/imageflux/)®.
WIP: Provide API client
## Installation
Add this line to your application's Gemfile:
```ruby
gem 'image_flux'
```And then execute:
$ bundle
Or install it yourself as:
$ gem install image_flux
## Usage
### Generate resize url for a path
```ruby
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
```ruby
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](https://rubygems.org).
## Contributing
Bug reports and pull requests are welcome on GitHub at .
## License
The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
## Notation
- ImageFlux is a registered trademark of [SAKURA Internet Inc.](https://www.sakura.ad.jp/).
- Regarding the use of this gem, pixiv Inc. and SAKURA Internet Inc. makes no responsibility.