bootic_client 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c3577184c13b3c030b8e7bce4bd7e560856564de
-  data.tar.gz: 06ceb2c371d1f60bdb4f246821397789401aa4d9
+  metadata.gz: 727d4868928f07359322ccc49dfed3d20edfae0a
+  data.tar.gz: 7626595ffbef58af0b052b6a74c3dc220b3e32ca
 SHA512:
-  metadata.gz: 5de054c0e2b96d5782e857f962991d27118552d23bd973d581a890d3074a46edb5869c36ff179a142f7b261dadb9d905ab7dae38d7b729d3b600b4bca8bbbff6
-  data.tar.gz: 43a6af6c0fef9c9bb91481b29a94fe788578778ff4a3d76942a56c7ce32992b3d5d7a7a5c05bc63fe0813c6b7837b17871da49f4764ebb55f069eef86663e09d
+  metadata.gz: 56d7d5c1c16e19f61f5d9e59de8b494f3ba20f8510c7eaba5d21a1d2aeab1a97eaf125c80c5923b524dd422c6f75904ddb5f20fd3c98f4d52765dce18e2e1071
+  data.tar.gz: 8fb91e3fcfbed8a09bf3903e3952f9078554b381d657eec9d92b08b1e955741a40c5e3c46b2f67dada5f3d0cac45feb1a337d2536c25a762606835a27af2ef94

data/README.md

@@ -88,6 +88,48 @@ client = BooticClient.client(:client_credentials, scope: 'admin', access_token:
 end
 ```
 
+## Non GET links
+
+Most resource links lead to `GET` resources, but some will expect `POST`, `PUT`, `DELETE` or others.
+
+The Bootic API encodes this information in its link metadata so the client will do the right thing. The following example creates a new product on your first shop:
+
+```ruby
+bootic = BooticClient.client(:client_credentials)
+
+root = bootic.root
+
+shop = root.shops.first
+
+if shop.can?(:create_product)
+  product = shop.create_product(
+    title: 'A shiny new product',
+    price: 122332,
+    status: "visible",
+    collecton_names: ["Featured products", "Homepage"],
+    variants: [
+      {
+        title: 'First variant',
+        sku: 'F23332-X',
+        available_if_no_stock: 1,
+        stock: 12
+      }
+    ]
+  )
+
+  puts product.rels[:web].href # => 'http://acme.bootic.net/products/a-shiny-new-product'
+end
+```
+
+## Relation docs
+
+All resource link relations include a "docs" URL so you can learn more about that particular resource.
+
+```ruby
+shop = root.shops.first
+puts shop.rels[:create_product] # => 'https://developers.bootic.net/rels/create_product'
+```
+
 ## Cache storage
 
 `BooticClient` honours HTTP caching headers included in API responses (such as `ETag` and `Last-Modified`).

data/lib/bootic_client/client.rb

@@ -9,6 +9,7 @@ module BooticClient
   class Client
 
     USER_AGENT = "[BooticClient v#{VERSION}] Ruby-#{RUBY_VERSION} - #{RUBY_PLATFORM}".freeze
+    JSON_MIME = 'application/json'.freeze
 
     attr_reader :options, :api_root
 
@@ -28,19 +29,30 @@ module BooticClient
       wrapper_class.new get(href, query).body, self
     end
 
-    def get(href, query = {})
-      validate_request!
+    def post_and_wrap(href, wrapper_class, payload = {})
+      wrapper_class.new post(href, payload).body, self
+    end
 
-      resp = conn.get do |req|
-        req.url href
-        req.params.update(query)
-        req.headers['Authorization'] = "Bearer #{options[:access_token]}"
-        req.headers['User-Agent'] = USER_AGENT
+    def get(href, query = {})
+      validated! do
+        conn.get do |req|
+          req.url href
+          req.headers.update request_headers
+          req.params.update(query)
+        end
       end
+    end
 
-      raise_if_invalid! resp
-
-      resp
+    def post(href, payload = {})
+      validated! do
+        conn.post do |req|
+          req.url href
+          req.headers.update request_headers
+          req.headers['Accept'] = JSON_MIME
+          req.headers['Content-Type'] = JSON_MIME
+          req.body = JSON.dump(payload)
+        end
+      end
     end
 
     protected
@@ -58,6 +70,20 @@ module BooticClient
       end
     end
 
+    def request_headers
+      {
+        'Authorization' => "Bearer #{options[:access_token]}",
+        'User-Agent' => USER_AGENT
+      }
+    end
+
+    def validated!(&block)
+      validate_request!
+      resp = yield
+      raise_if_invalid! resp
+      resp
+    end
+
     def validate_request!
       raise NoAccessTokenError, "Missing access token" unless options[:access_token]
     end

data/lib/bootic_client/entity.rb

@@ -23,6 +23,10 @@ module BooticClient
       has_property?(prop_name) || has_entity?(prop_name) || has_rel?(prop_name)
     end
 
+    def can?(rel_name)
+      has_rel? rel_name
+    end
+
     def inspect
       %(#<#{self.class.name} props: [#{properties.keys.join(', ')}] rels: [#{rels.keys.join(', ')}] entities: [#{entities.keys.join(', ')}]>)
     end
@@ -55,7 +59,7 @@ module BooticClient
         elsif has_entity?(name)
           entities[name]
         elsif has_rel?(name)
-          rels[name].get(*args)
+          rels[name].run(*args)
         else
           super
         end

data/lib/bootic_client/relation.rb

@@ -5,6 +5,8 @@ module BooticClient
 
   class Relation
 
+    GET = 'get'.freeze
+
     def initialize(attrs, client, wrapper_class = Entity)
       @attrs, @client, @wrapper_class = attrs, client, wrapper_class
     end
@@ -37,6 +39,14 @@ module BooticClient
       attrs['docs']
     end
 
+    def transport_method
+      @transport_method ||= attrs['method'] || GET
+    end
+
+    def run(opts = {})
+      self.send(transport_method, opts)
+    end
+
     def get(opts = {})
       if templated?
         client.get_and_wrap uri.expand(opts), wrapper_class
@@ -45,6 +55,10 @@ module BooticClient
       end
     end
 
+    def post(opts = {})
+      client.post_and_wrap href, wrapper_class, opts
+    end
+
     def self.expand(href, opts = {})
       URITemplate.new(href).expand(opts)
     end

data/lib/bootic_client/version.rb

@@ -1,3 +1,3 @@
 module BooticClient
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/spec/client_spec.rb

@@ -135,5 +135,20 @@ describe BooticClient::Client do
       end
     end
 
+    describe '#post_and_wrap' do
+      before do
+        stub_request(:post, root_url)
+          .with(body: JSON.dump({foo: 'bar'}), headers: {'Accept' => 'application/json', 'Content-Type' => 'application/json'})
+          .to_return(status: 200, body: JSON.dump(root_data), headers: response_headers)
+      end
+
+      it 'wraps JSON response in entity' do
+        wrapper = double('Wrapper Class')
+        entity = double('Entity')
+        expect(wrapper).to receive(:new).with(root_data, client).and_return entity
+        expect(client.post_and_wrap(root_url, wrapper, foo: 'bar')).to eql(entity)
+      end
+    end
+
   end
 end

data/spec/entity_spec.rb

@@ -111,6 +111,11 @@ describe BooticClient::Entity do
         expect(entity.has?(:next)).to eql(true)
       end
 
+      it 'responds to #can? for link relations' do
+        expect(entity.can?(:next)).to eql(true)
+        expect(entity.can?(:foo)).to eql(false)
+      end
+
       it 'builds relation objects' do
         expect(entity.rels[:next]).to be_kind_of(BooticClient::Relation)
         expect(entity.rels[:next].href).to eql('/foo?page=2')

data/spec/relation_spec.rb

@@ -13,42 +13,53 @@ describe BooticClient::Relation do
     end
   end
 
-  describe '#get' do
+  describe '#run' do
     let(:entity) { BooticClient::Entity.new({'title' => 'Foobar'}, client) }
 
-    it 'fetches data and returns entity' do
-      client.stub(:get_and_wrap).with('/foo/bars', BooticClient::Entity, {}).and_return entity
-      expect(relation.get).to eql(entity)
-    end
+    describe 'running GET by default' do
+      it 'fetches data and returns entity' do
+        client.stub(:get_and_wrap).with('/foo/bars', BooticClient::Entity, {}).and_return entity
+        expect(relation.run).to eql(entity)
+      end
 
-    context 'without URI templates' do
-      let(:relation) { BooticClient::Relation.new({'href' => '/foos/bar', 'type' => 'application/json', 'title' => 'A relation'}, client) }
+      context 'without URI templates' do
+        let(:relation) { BooticClient::Relation.new({'href' => '/foos/bar', 'type' => 'application/json', 'title' => 'A relation'}, client) }
 
-      it 'is not templated' do
-        expect(relation.templated?).to eql(false)
-      end
+        it 'is not templated' do
+          expect(relation.templated?).to eql(false)
+        end
 
-      it 'passes query string to client' do
-        expect(client).to receive(:get_and_wrap).with('/foos/bar', BooticClient::Entity, id: 2, q: 'test', page: 2).and_return entity
-        expect(relation.get(id: 2, q: 'test', page: 2)).to eql(entity)
+        it 'passes query string to client' do
+          expect(client).to receive(:get_and_wrap).with('/foos/bar', BooticClient::Entity, id: 2, q: 'test', page: 2).and_return entity
+          expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
+        end
       end
-    end
 
-    context 'with URI templates' do
-      let(:relation) { BooticClient::Relation.new({'href' => '/foos/{id}{?q,page}', 'type' => 'application/json', 'title' => 'A relation', 'templated' => true}, client) }
+      context 'with URI templates' do
+        let(:relation) { BooticClient::Relation.new({'href' => '/foos/{id}{?q,page}', 'type' => 'application/json', 'title' => 'A relation', 'templated' => true}, client) }
 
-      it 'is templated' do
-        expect(relation.templated?).to eql(true)
-      end
+        it 'is templated' do
+          expect(relation.templated?).to eql(true)
+        end
+
+        it 'works with defaults' do
+          expect(client).to receive(:get_and_wrap).with('/foos/', BooticClient::Entity).and_return entity
+          expect(relation.run).to eql(entity)
+        end
 
-      it 'works with defaults' do
-        expect(client).to receive(:get_and_wrap).with('/foos/', BooticClient::Entity).and_return entity
-        expect(relation.get).to eql(entity)
+        it 'interpolates tokens' do
+          expect(client).to receive(:get_and_wrap).with('/foos/2?q=test&page=2', BooticClient::Entity).and_return entity
+          expect(relation.run(id: 2, q: 'test', page: 2)).to eql(entity)
+        end
       end
+    end
+
+    describe 'POST' do
+      let(:relation) { BooticClient::Relation.new({'href' => '/foo/bars', 'type' => 'application/json', 'name' => 'self', 'method' => 'post'}, client) }
 
-      it 'interpolates tokens' do
-        expect(client).to receive(:get_and_wrap).with('/foos/2?q=test&page=2', BooticClient::Entity).and_return entity
-        expect(relation.get(id: 2, q: 'test', page: 2)).to eql(entity)
+      it 'POSTS data and returns resulting entity' do
+        client.stub(:post_and_wrap).with('/foo/bars', BooticClient::Entity, {}).and_return entity
+        expect(relation.run).to eql(entity)
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: bootic_client
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Ismael Celis
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-06-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday