imageboss-rb 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b261b09c7de94415ab69c0c6a0cc4485231434f9
-  data.tar.gz: 56d13e6cfaeb4c999f6c1241d64a2945ebc7dc4e
+  metadata.gz: eec9d1afdfab1c6d949f3b94db2b975170458cdc
+  data.tar.gz: 16717c093fbb2e432bf27a704125c0ea4e85b78e
 SHA512:
-  metadata.gz: ae4c3eb20e937d0f665ee092e9018157bb578f4f924883bd0b74b3b7090cfff6ce9be14455ad7609457d59cdc00953fb17241a14f3d2c4002bccea4d15552754
-  data.tar.gz: 2552e3bf2bdbd03fa77497838811a7351012e4e4010872a57f0004af188ce2e4dd67dfb8ccb06896a08d6f1d7e52af5874608dc73b6199207ade177d00e87012
+  metadata.gz: f5a07ee9cafcef9ee1901c60d59f827b1cd5be7c824a585aaf97f1b466acc977a80c0c27bcdb0631195ce66b480561731e18e33efcf67f8840b685435612a5b5
+  data.tar.gz: abacadc151cebaa6485598d5cd83e397b162611e4fa2a1644a09b67ab045d2426d8d1fe63eab2ae34aaddfb2e063db4c1f14e711ac1e108132444fa13ef35bb4

data/Gemfile.lock

@@ -1,12 +1,11 @@
 PATH
   remote: .
   specs:
-    imageboss-rb (1.0.0)
+    imageboss-rb (1.0.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    byebug (10.0.0)
     diff-lcs (1.3)
     rspec (3.7.0)
       rspec-core (~> 3.7.0)
@@ -26,7 +25,6 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  byebug
   imageboss-rb!
   rspec
 

data/README.md

@@ -1,4 +1,5 @@
-# ImageBoss Helper for Ruby [![Build Status](https://travis-ci.org/imageboss/imageboss-rb.svg?branch=master)](https://travis-ci.org/imageboss/imageboss-rb)
+# ImageBoss Helper for Ruby
+[![Build Status](https://travis-ci.org/imageboss/imageboss-rb.svg?branch=master)](https://travis-ci.org/imageboss/imageboss-rb) [![Gem Version](https://badge.fury.io/rb/imageboss-rb.svg)](https://badge.fury.io/rb/imageboss-rb)
 
 Official Gem for generating ImageBoss URLs.
 [https://imageboss.me/](https://imageboss.me/)
@@ -18,33 +19,50 @@ gem install imageboss-rb
 ## Usage
 ### Example `Image Resizing With Cover Operation`
 ```ruby
-client = ImageBoss::Client.new('https://mywebsite.com')
+client = ImageBoss::Client.new(domain: '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')
+client = ImageBoss::Client.new(domain: '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')
+client = ImageBoss::Client.new(domain: '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
+
+#=> https://service.imageboss.me/width/100/grayscale:true/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).
 
+### Disabling URL generation
+If you are coding on `test`, `development` environments and don't want to send any image to ImageBoss
+you can always disable the URL generation and the client will just fallback to the original path provided.
+
+```ruby
+client = ImageBoss::Client.new(domain: 'https://mywebsite.com', disabled: true)
+
+image_url = client.path('/images/img01.jpg')
+                  .operation(:width, width: 100, options: { grayscale: true })
+
+#=> /images/img01.jpg
+```
+This will give you the ability to see your image without adding extra code to handle this situation.
+
 ## Tested on
 Ruby
   - 2.5.1

data/lib/imageboss/client.rb

@@ -1,11 +1,14 @@
 module ImageBoss
   class Client
-    def initialize(domain:)
-      @domain = domain
+    def initialize(domain:, enabled: true)
+      @options = {
+        domain: domain,
+        enabled: enabled
+      }
     end
 
     def path(asset_path)
-      Path.new(@domain, asset_path)
+      Path.new(@options, asset_path)
     end
   end
 end

data/lib/imageboss/path.rb

@@ -12,12 +12,15 @@ module ImageBoss
       cdn: { recipe: '/:operation/:options/', required: [] }
     }.freeze
 
-    def initialize(domain, asset_path)
-      @domain = domain.chomp('/')
+    def initialize(client_options, asset_path)
+      @client_options = client_options
+      @domain = client_options[:domain].chomp('/')
       @asset_path = asset_path
     end
 
     def operation(name, options = {})
+      return @asset_path unless @client_options[:enabled]
+
       @operation_name = name.to_sym
       @options = options
       @extra_options = parse_options(options[:options])

data/lib/imageboss/version.rb

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

data/spec/imageboss/client_spec.rb

@@ -11,7 +11,11 @@ describe ImageBoss::Client do
   subject { described_class.new(**client_args) }
 
   context 'initialize' do
-    it { expect(subject.instance_variable_get(:@domain)).to eq client_args[:domain] }
+    it { expect(subject.instance_variable_get(:@options)).to eq({
+        domain: client_args[:domain],
+        enabled: true
+      })
+    }
   end
 
   context 'path' do
@@ -56,5 +60,15 @@ describe ImageBoss::Client do
       let(:operation_args) { [:cdn] }
       it { expect(image_url).to eq "#{service}/cdn/https://myassets.com/assets/img01.jpg" }
     end
+
+    fcontext 'disabled  client' do
+      let(:client_args) {{
+        domain: 'https://myassets.com',
+        enabled: false
+      }}
+
+      let(:operation_args) { [:height, height: 200 ] }
+      it { expect(image_url).to eq '/assets/img01.jpg' }
+    end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: imageboss-rb
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Igor Escobar
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-04 00:00:00.000000000 Z
+date: 2018-04-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec