imageboss-rb 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b261b09c7de94415ab69c0c6a0cc4485231434f9
+  data.tar.gz: 56d13e6cfaeb4c999f6c1241d64a2945ebc7dc4e
+SHA512:
+  metadata.gz: ae4c3eb20e937d0f665ee092e9018157bb578f4f924883bd0b74b3b7090cfff6ce9be14455ad7609457d59cdc00953fb17241a14f3d2c4002bccea4d15552754
+  data.tar.gz: 2552e3bf2bdbd03fa77497838811a7351012e4e4010872a57f0004af188ce2e4dd67dfb8ccb06896a08d6f1d7e52af5874608dc73b6199207ade177d00e87012

data/.gitignore

@@ -0,0 +1,50 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,17 @@
+language: ruby
+cache: bundler
+bundler_args: "--binstubs --path ../bundle --retry=3 --jobs=3"
+before_install:
+  - gem install bundler
+  - rvm get head
+  - bundle install
+script:
+  - bundle exec rspec
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.7
+  - 2.1.10
+  - jruby-9.0.5.0
+  - rbx-3.100

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,34 @@
+PATH
+  remote: .
+  specs:
+    imageboss-rb (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    byebug (10.0.0)
+    diff-lcs (1.3)
+    rspec (3.7.0)
+      rspec-core (~> 3.7.0)
+      rspec-expectations (~> 3.7.0)
+      rspec-mocks (~> 3.7.0)
+    rspec-core (3.7.1)
+      rspec-support (~> 3.7.0)
+    rspec-expectations (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-mocks (3.7.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.7.0)
+    rspec-support (3.7.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  byebug
+  imageboss-rb!
+  rspec
+
+BUNDLED WITH
+   1.16.0

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# ImageBoss Helper for Ruby [![Build Status](https://travis-ci.org/imageboss/imageboss-rb.svg?branch=master)](https://travis-ci.org/imageboss/imageboss-rb)
+
+Official Gem for generating ImageBoss URLs.
+[https://imageboss.me/](https://imageboss.me/)
+
+## Installation
+Add this line to your application's Gemfile:
+```
+bundle add imageboss-rb
+```
+
+Or install it yourself as:
+
+```
+gem install imageboss-rb
+```
+
+## Usage
+### Example `Image Resizing With Cover Operation`
+```ruby
+client = ImageBoss::Client.new('https://mywebsite.com')
+
+image_url = client.path('/images/img01.jpg')
+                  .operation(:cover, width: 100, height: 100)
+#=> https://service.imageboss.me/cover/100x100/https://mywebsite.com/images/img01.jpg
+```
+
+### Example `Image Resizing With Height Operation`
+```ruby
+client = ImageBoss::Client.new('https://mywebsite.com')
+
+image_url = client.path('/images/img01.jpg')
+                  .operation(:height, height: 100)
+#=> https://service.imageboss.me/height/100/https://mywebsite.com/images/img01.jpg
+```
+
+### Example `Image Resizing With Extra Options`
+```ruby
+client = ImageBoss::Client.new('https://mywebsite.com')
+
+image_url = client.path('/images/img01.jpg')
+                  .operation(:width, width: 100, options: { grayscale: true })
+#=> https://service.imageboss.me/width/100/grayscale:trye/https://mywebsite.com/images/img01.jpg
+```
+### All operations and options for Image Resizing
+It's all available on our [Official Docs](https://imageboss.me/docs).
+
+## Tested on
+Ruby
+  - 2.5.1
+  - 2.4.4
+  - 2.3.7
+  - 2.2.7
+  - 2.1.10
+
+jRuby
+  - jruby-9.0.5.0
+
+Rubinius
+  - rbx-3.100

data/imageboss-rb.gemspec

@@ -0,0 +1,22 @@
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'imageboss/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'imageboss-rb'
+  spec.version       = ImageBoss::VERSION
+  spec.authors       = ['Igor Escobar']
+  spec.email         = ['igor@imageboss.me']
+  spec.description   = 'Generate ImageBoss URLs with Ruby'
+  spec.summary       = 'Official Ruby Gem for generating ImageBoss URLs.'
+  spec.homepage      = 'https://github.com/imageboss/imageboss-rb'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.required_ruby_version = '>= 1.9.0'
+  spec.add_development_dependency "rspec"
+end

data/lib/imageboss.rb

@@ -0,0 +1,5 @@
+require 'imageboss/path'
+require 'imageboss/client'
+
+module ImageBoss
+end

data/lib/imageboss/client.rb

@@ -0,0 +1,11 @@
+module ImageBoss
+  class Client
+    def initialize(domain:)
+      @domain = domain
+    end
+
+    def path(asset_path)
+      Path.new(@domain, asset_path)
+    end
+  end
+end

data/lib/imageboss/path.rb

@@ -0,0 +1,59 @@
+module ImageBoss
+  class Path
+    SERVICE_URL = 'https://service.imageboss.me'.freeze
+    OPERATIONS = {
+      cover: {
+        recipe: '/:operation::mode/:widthx:height/:options/', required: [:width, :height]
+      },
+      width: {
+        recipe: '/:operation/:width/:options/', required: [:width]
+      },
+      height: { recipe: '/:operation/:height/:options/', required: [:height]},
+      cdn: { recipe: '/:operation/:options/', required: [] }
+    }.freeze
+
+    def initialize(domain, asset_path)
+      @domain = domain.chomp('/')
+      @asset_path = asset_path
+    end
+
+    def operation(name, options = {})
+      @operation_name = name.to_sym
+      @options = options
+      @extra_options = parse_options(options[:options])
+      @operation = OPERATIONS[@operation_name]
+      @required = @operation[:required]
+
+      @required.each do |r|
+        @options.fetch(r)
+      end
+
+      recipe = [
+        SERVICE_URL,
+        @operation[:recipe].chomp('/'),
+        @domain,
+        @asset_path
+      ].join
+      parse(recipe)
+    end
+    private
+
+    def parse(recipe)
+      recipe
+        .sub(':operation', @operation_name.to_s)
+        .sub(':width', @options[:width].to_s)
+        .sub(':height', @options[:height].to_s)
+        .sub(':options', @extra_options.empty? ? "" : "#{@extra_options}/")
+        .sub('::mode', @options[:mode] ? ":#{@options[:mode]}" : '').to_s
+    end
+
+    def parse_options(options = {})
+      valid_options = [ :grayscale, :blur ]
+      opts = []
+      valid_options.each do |vo|
+        opts << [vo.to_s, options[vo] ].join(':') if options && options.has_key?(vo)
+      end
+      opts.join(',')
+    end
+  end
+end

data/lib/imageboss/version.rb

@@ -0,0 +1,3 @@
+module ImageBoss
+  VERSION = '1.0.0'
+end

data/spec/imageboss/client_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe ImageBoss::Client do
+  let(:service) { 'https://service.imageboss.me' }
+  let(:client_args) {{
+    domain: 'https://myassets.com'
+  }}
+
+  let(:operation_args) { [:cover, width: 100, height: 100] }
+
+  subject { described_class.new(**client_args) }
+
+  context 'initialize' do
+    it { expect(subject.instance_variable_get(:@domain)).to eq client_args[:domain] }
+  end
+
+  context 'path' do
+    let(:path) {
+      subject
+        .path('/assets/img01.jpg')
+    }
+
+    let(:image_url) { path.operation(*operation_args) }
+
+    context 'cover' do
+      it { expect(image_url).to eq "#{service}/cover/100x100/https://myassets.com/assets/img01.jpg" }
+
+      context 'with options' do
+        let(:operation_args) { [:cover, width: 100, height: 100, options: { grayscale: true, blur: 2.0 } ] }
+        it { expect(image_url).to eq "#{service}/cover/100x100/grayscale:true,blur:2.0/https://myassets.com/assets/img01.jpg" }
+      end
+
+      context 'mode' do
+        let(:operation_args) { [:cover, mode: :entropy, width: 100, height: 100 ] }
+        it { expect(image_url).to eq "#{service}/cover:entropy/100x100/https://myassets.com/assets/img01.jpg" }
+
+        context 'with options' do
+          let(:operation_args) { [:cover, mode: :entropy, width: 100, height: 100, options: { grayscale: true, blur: 2.0 } ] }
+          it { expect(image_url).to eq "#{service}/cover:entropy/100x100/grayscale:true,blur:2.0/https://myassets.com/assets/img01.jpg" }
+        end
+      end
+
+    end
+
+    context 'width' do
+      let(:operation_args) { [:width, width: 100 ] }
+      it { expect(image_url).to eq "#{service}/width/100/https://myassets.com/assets/img01.jpg" }
+    end
+
+    context 'height' do
+      let(:operation_args) { [:height, height: 200 ] }
+      it { expect(image_url).to eq "#{service}/height/200/https://myassets.com/assets/img01.jpg" }
+    end
+
+    context 'cdn' do
+      let(:operation_args) { [:cdn] }
+      it { expect(image_url).to eq "#{service}/cdn/https://myassets.com/assets/img01.jpg" }
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'imageboss'
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,74 @@
+--- !ruby/object:Gem::Specification
+name: imageboss-rb
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Igor Escobar
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-04-04 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generate ImageBoss URLs with Ruby
+email:
+- igor@imageboss.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- imageboss-rb.gemspec
+- lib/imageboss.rb
+- lib/imageboss/client.rb
+- lib/imageboss/path.rb
+- lib/imageboss/version.rb
+- spec/imageboss/client_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/imageboss/imageboss-rb
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Official Ruby Gem for generating ImageBoss URLs.
+test_files:
+- spec/imageboss/client_spec.rb
+- spec/spec_helper.rb