bootic_client 0.0.13 → 0.0.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1e814afcd60c951637016f9a3435104816be4420
-  data.tar.gz: 37287bbd0a9d96c8fbd9bd5f05be64558ab125a9
+  metadata.gz: 7bd5c38b36abf80f522f33986103d5d2d94c2ba0
+  data.tar.gz: 5f11c6edb651d08e49cbbf1e8bd2a89037cfd3e8
 SHA512:
-  metadata.gz: 696f4e4e34eb96ae1160c8b13520080ea99d79a75bef73280714b16978a84bfc119177025f4daebd5828c4f2e00afeb4d7483a0cde4b68a6e9366d16e23253f2
-  data.tar.gz: bc751c6bbb19f08012f38770c9365af27fdbd61bb1278b35be81e8340c751f024c8f94f892642327fd9bd87aca6150a3f572027c1039d1518b3292e3f50f5b4a
+  metadata.gz: 8afbb75506aa39f78af563d6aa7b926f4fe9993554f9a79288d606af3bf11002423bc9bcfd1a66d633006ee37c8b69a3bb9987d1551d12b41f6c14941f7b77cc
+  data.tar.gz: fda4d8271434e14c7502329f8b3448f95a570628fed0ac6afb8dd6b380927a95fc4a39b26a77d77ae8d95c33b01a32523af784798c5e37507c03ccc1d7daa04d

data/CHANGELOG.md

@@ -1,5 +1,12 @@
 # Change Log
 
+## [v0.0.13](https://github.com/bootic/bootic_client.rb/tree/v0.0.13) (2016-01-12)
+[Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.12...v0.0.13)
+
+**Merged pull requests:**
+
+- Faraday HTTP Cache expects memcache store must respond to \#delete [\#5](https://github.com/bootic/bootic_client.rb/pull/5) ([ismasan](https://github.com/ismasan))
+
 ## [v0.0.12](https://github.com/bootic/bootic_client.rb/tree/v0.0.12) (2016-01-11)
 [Full Changelog](https://github.com/bootic/bootic_client.rb/compare/v0.0.11...v0.0.12)
 

data/README.md

@@ -165,6 +165,17 @@ if shop.can?(:create_product)
 end
 ```
 
+### Working with Files and IO instances
+
+Instances of `File` and other readable `IO` objects will be base64-encoded internally before JSON-encoding payloads for `POST`, `PUT` and `PATCH` requests.
+
+```ruby
+asset = product.create_product_asset(
+  filename: 'foo.jpg',
+  data: File.new('/path/to/foo.jpg') # this will base64-encode the file data in the `data` field.
+)
+```
+
 ## Relation docs
 
 All resource link relations include a "docs" URL so you can learn more about that particular resource.
@@ -187,7 +198,7 @@ BooticClient.configure do |c|
 end
 ```
 
-Outside of Rails, BooticClient ships with a wrapper around the [Dalli](https://github.com/mperham/dalli) memcache client. 
+Outside of Rails, BooticClient ships with a wrapper around the [Dalli](https://github.com/mperham/dalli) memcache client.
 You must include Dalli in your Gemfile and require the wrapper explicitely.
 
 ```ruby

data/lib/bootic_client/client.rb

@@ -1,3 +1,4 @@
+require 'base64'
 require 'faraday'
 require 'faraday_middleware'
 require 'faraday-http-cache'
@@ -33,21 +34,21 @@ module BooticClient
     def post(href, payload = {}, headers = {})
       validated_request!(:post, href) do |req|
         req.headers.update headers
-        req.body = JSON.dump(payload)
+        req.body = JSON.dump(sanitized(payload))
       end
     end
 
     def put(href, payload = {}, headers = {})
       validated_request!(:put, href) do |req|
         req.headers.update headers
-        req.body = JSON.dump(payload)
+        req.body = JSON.dump(sanitized(payload))
       end
     end
 
     def patch(href, payload = {}, headers = {})
       validated_request!(:patch, href) do |req|
         req.headers.update headers
-        req.body = JSON.dump(payload)
+        req.body = JSON.dump(sanitized(payload))
       end
     end
 
@@ -97,6 +98,20 @@ module BooticClient
       raise UnauthorizedError, "Unauthorized request" if resp.status == 401
       raise AccessForbiddenError, "Access Forbidden" if resp.status == 403
     end
+
+    def sanitized(payload)
+      return payload unless payload.kind_of?(Hash)
+      payload.each_with_object({}) do |(k, v), memo|
+        memo[k] = case v
+        when IO
+          Base64.encode64 v.read
+        when Hash
+          sanitized v
+        else
+          v
+        end
+      end
+    end
   end
 
 end

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.13"
+  VERSION = "0.0.14"
 end

data/spec/client_spec.rb

@@ -4,6 +4,10 @@ require 'json'
 describe BooticClient::Client do
   require 'webmock/rspec'
 
+  def fixture_path(filename)
+    File.join File.dirname(File.expand_path(__FILE__)), 'fixtures', filename
+  end
+
   describe 'valid response' do
     let(:root_url) { 'https://api.bootic.net/v1' }
     let(:client) { BooticClient::Client.new }
@@ -187,6 +191,21 @@ describe BooticClient::Client do
         end
       end
 
+      describe 'with file data' do
+        let(:base64_data) { Base64.encode64(File.read(fixture_path('file.gif'))) }
+        let(:file) { File.new(fixture_path('file.gif')) }
+
+        before do
+          stub_request(:post, root_url)
+            .with(body: JSON.dump({foo: 'bar', data: base64_data}), headers: request_headers)
+            .to_return(status: 201, body: JSON.dump(root_data), headers: response_headers)
+        end
+
+        it 'POSTs request with base64-encoded file and parses response' do
+          expect(client.post(root_url, {foo: 'bar', data: file}, request_headers).body['message']).to eql('Hello!')
+        end
+      end
+
       [:put, :patch].each do |verb|
         describe verb.to_s.upcase do
           before do
@@ -199,6 +218,21 @@ describe BooticClient::Client do
             expect(client.send(verb, root_url, {foo: 'bar'}, request_headers).body['message']).to eql('Hello!')
           end
         end
+
+        describe "#{verb.to_s.upcase} with file data" do
+          let(:base64_data) { Base64.encode64(File.read(fixture_path('file.gif'))) }
+          let(:file) { File.new(fixture_path('file.gif')) }
+
+          before do
+            stub_request(verb, root_url)
+              .with(body: JSON.dump({foo: 'bar', data: {name: 'la', file: base64_data}}), headers: request_headers)
+              .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+          end
+
+          it "#{verb.to_s.upcase}s request with base64-encoded file data and parses response" do
+            expect(client.send(verb, root_url, {foo: 'bar', data: {name: 'la', file: file}}, request_headers).body['message']).to eql('Hello!')
+          end
+        end
       end
 
       context 'DELETE' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.13
+  version: 0.0.14
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-01-12 00:00:00.000000000 Z
+date: 2016-04-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -198,6 +198,7 @@ files:
 - spec/client_credentials_strategy_spec.rb
 - spec/client_spec.rb
 - spec/entity_spec.rb
+- spec/fixtures/file.gif
 - spec/memcache_storage_spec.rb
 - spec/relation_spec.rb
 - spec/spec_helper.rb
@@ -232,6 +233,7 @@ test_files:
 - spec/client_credentials_strategy_spec.rb
 - spec/client_spec.rb
 - spec/entity_spec.rb
+- spec/fixtures/file.gif
 - spec/memcache_storage_spec.rb
 - spec/relation_spec.rb
 - spec/spec_helper.rb