siren_client 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d38e18a3d8e7b27a74a1bf4e39a87de411eba9b
-  data.tar.gz: 533cc402ef1239c82ccdac742caaaf9fb0dff276
+  metadata.gz: 0bb4a69b5cf6283d4600e932cdff36f0a6b491c1
+  data.tar.gz: cc297a74136cff297fe049b4bfc7f44a3a45b8c7
 SHA512:
-  metadata.gz: bc1e058531f13b91a3f043861407bda4a978a55566650a4f00f7de1043b2db8f9f150aba0c0852a47eae4caff867ac6da1888b39491c64fc638cd7e24ab58dd8
-  data.tar.gz: ee8785bd0cc1ee33529aebe40d2dea9eeee3b84635fb2623935033752296a889f50ac55750c0a5f4c523ef0a95249079867abbd21a7b1a9dedc73980be31a405
+  metadata.gz: f78a0a0b758d5c5374e35d4871c895103847e81436f8224f1d2a1009642d6e2a52ec256dfbfe6b70abb10d7de448c8b7a5b87527d84d1936df21aa0f5638399b
+  data.tar.gz: 88d809060672563d5e1a7d1daaed24fe005eba79eabc4f1e63bb1328534f5a0a21d0b54ba104d879a6628cb311b8dbf43c537379b6bcb3b2905525b05935039d

data/.travis.yml

@@ -1,11 +1,9 @@
-before_install:
-  - 'if [[ "$TRAVIS_RUBY_VERSION" =~ "jruby" ]]; then rvm get head && rvm reload && rvm use --install $TRAVIS_RUBY_VERSION; fi'
 language: ruby
 rvm:
-  - "1.9.3"
-  - "2.0.0"
-  - "2.1.0"
-  - "2.2.0"
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - 2.2.0
   - jruby-19mode
   - jruby-9.0.5.0
 script: bundle exec rspec

data/lib/siren_client.rb

@@ -3,7 +3,6 @@ require "#{dir}/version"
 
 # Dependencies
 require 'json'
-require 'logger'
 require 'httparty'
 require 'active_support/inflector'
 require 'active_support/core_ext/hash'

data/lib/siren_client/action.rb

@@ -12,7 +12,7 @@ module SirenClient
       end
       @payload = data
 
-      @config = { format: :json }.merge config 
+      @config = { format: :json }.merge config
       @name    = @payload['name']   || ''
       @classes = @payload['class']  || []
       @method  = (@payload['method'] || 'GET').downcase
@@ -34,17 +34,15 @@ module SirenClient
       end
       options[:headers]['Content-Type'] = @type
       begin
-        query = options[:query].empty? ? '' : ('?' + options[:query].to_query)
-        SirenClient.logger.debug "#{@method.upcase} #{@href}#{query}"
-        options[:headers].each do |k, v|
-          SirenClient.logger.debug "  #{k}: #{v}"
-        end
-        SirenClient.logger.debug '  ' + options[:body].to_query unless options[:body].empty?
+        resp = generate_raw_response(@method, self.href, options)
         if next_response_is_raw?
           disable_raw_response
-          generate_raw_response(self.href, @config)
+          resp
         else
-          Entity.new(HTTParty.send(@method.to_sym, @href, options).parsed_response, @config)
+          if resp.parsed_response.nil?
+            raise InvalidResponseError.new "Response could not be parsed. Code=#{resp.code} Message=\"#{resp.message}\" Body=#{resp.body}"
+          end
+          Entity.new(resp.parsed_response, @config)
         end
       rescue URI::InvalidURIError => e
         raise InvalidURIError, e.message
@@ -52,5 +50,8 @@ module SirenClient
         raise InvalidResponseError, e.message
       end
     end
+    # `.submit` should be used with actions that
+    # don't require any parameters, for readability.
+    alias_method :submit, :where
   end
 end

data/lib/siren_client/base.rb

@@ -1,30 +1,11 @@
 module SirenClient
-  # Add a logger that gets passed in from an outside source
-  # or default to a standard logger. This will allow different
-  # setups i.e. java logging to log wherever/however they wish.
-  @@logger = Logger.new(STDOUT)
-  @@logger.level = Logger::WARN
-  @@logger.progname = 'SirenClient.' + SirenClient::VERSION
-  def self.logger; @@logger; end
-  def self.logger=(log)
-    unless  log.respond_to?(:debug) &&
-            log.respond_to?(:info)  &&
-            log.respond_to?(:warn)  &&
-            log.respond_to?(:error) &&
-            log.respond_to?(:fatal)
-      raise InvalidLogger, "The logger object does not respond to [:debug, :info, :warn, :error, :fatal]."
-    end
-    @@logger = log
-    @@logger.progname = 'SirenClient.' + SirenClient::VERSION
-  end
-
   def self.get(options)
     if options.is_a? String
       Entity.new(options)
     elsif options.is_a? Hash
       url = options[:url] || options['url']
       raise ArgumentError, "You must supply a valid url to SirenClient.get" unless url
-      Entity.new(url, options)    
+      Entity.new(url, options)
     else
       raise ArgumentError, 'You must supply either a string or hash to SirenClient.get'
     end

data/lib/siren_client/entity.rb

@@ -16,8 +16,11 @@ module SirenClient
           raise InvalidURIError, 'An invalid url was passed to SirenClient::Entity.new.'
         end
         begin
-          SirenClient.logger.debug "GET #{data}"
-          @payload = HTTParty.get(data, @config).parsed_response
+          resp = generate_raw_response(:get, data, @config)
+          if resp.parsed_response.nil?
+            raise InvalidResponseError.new "Response could not be parsed. Code=#{resp.code} Message=\"#{resp.message}\" Body=#{resp.body}"
+          end
+          @payload = resp.parsed_response
         rescue URI::InvalidURIError => e
           raise InvalidURIError, e.message
         rescue JSON::ParserError => e
@@ -39,8 +42,8 @@ module SirenClient
       else
         if next_response_is_raw?
           disable_raw_response
-          @entities[i].with_raw_response.go 
-        else 
+          @entities[i].with_raw_response.go
+        else
           @entities[i].go
         end
       end
@@ -72,7 +75,7 @@ module SirenClient
       return if self.href.empty?
       if next_response_is_raw?
         disable_raw_response
-        generate_raw_response(self.href, @config)
+        generate_raw_response(:get, self.href, @config)
       else
         self.class.new(self.href, @config)
       end
@@ -103,7 +106,7 @@ module SirenClient
             disable_raw_response
             return link.with_raw_response.go
           else
-            return link.go 
+            return link.go
           end
         end
       end

data/lib/siren_client/exceptions.rb

@@ -2,5 +2,4 @@ module SirenClient
   class StandardError        < ::StandardError; end
   class InvalidURIError      < StandardError; end
   class InvalidResponseError < StandardError; end
-  class InvalidLogger        < StandardError; end
 end

data/lib/siren_client/link.rb

@@ -4,14 +4,14 @@ module SirenClient
 
     attr_accessor :href
     attr_reader :payload, :rels, :title, :type, :config
-    
+
     def initialize(data, config={})
       super()
       if data.class != Hash
         raise ArgumentError, "You must pass in a Hash to SirenClient::Link.new"
       end
       @payload = data
-      @config = { format: :json }.merge config 
+      @config = { format: :json }.merge config
 
       @rels  = @payload['rel']   || []
       @href  = @payload['href']  || ''
@@ -22,7 +22,7 @@ module SirenClient
     def go
       if next_response_is_raw?
         disable_raw_response
-        generate_raw_response(self.href, @config)
+        generate_raw_response(:get, self.href, @config)
       else
         Entity.new(self.href, @config)
       end

data/lib/siren_client/modules/with_raw_response.rb

@@ -18,10 +18,10 @@ module SirenClient
         @_next_response_is_raw
       end
 
-      private 
+      private
 
-      def generate_raw_response(url, config)
-        RawResponse.new HTTParty.get(url, config)
+      def generate_raw_response(method, url, config)
+        RawResponse.new HTTParty.send(method.to_sym, url, config)
       end
     end
   end

data/lib/siren_client/raw_response.rb

@@ -1,5 +1,7 @@
 module SirenClient
   class RawResponse
+    attr_accessor :response
+
     def initialize(http_res)
         unless http_res.class == HTTParty::Response
           raise InvalidResponseError, "SirenClient::RawResponse expects a HTTParty::Response instance."
@@ -7,8 +9,12 @@ module SirenClient
         @response = http_res
     end
 
+    def parsed_response
+      @response.parsed_response
+    end
+
     def body
-      @response.body 
+      @response.body
     end
 
     def code

data/lib/siren_client/version.rb

@@ -1,3 +1,3 @@
 module SirenClient
-  VERSION = "0.3.0"
+  VERSION = "1.0.0"
 end

data/spec/live/traverse_spec.rb

@@ -12,7 +12,7 @@ end
 
 describe SirenClient do
   context 'when creating an entity' do
-    let (:headers_ent) { 
+    let (:headers_ent) {
       SirenClient.get({
         url: URL,
         basic_auth: { username: 'admin', password: '1234' },
@@ -22,7 +22,7 @@ describe SirenClient do
     it 'can set HTTP headers' do
       expect {
         expect(headers_ent.config[:headers]).to be_a Hash
-        expect(headers_ent.config[:headers]).to eq({ 
+        expect(headers_ent.config[:headers]).to eq({
           "Accept" => "application/json"
         })
       }.to_not raise_error
@@ -34,14 +34,14 @@ describe SirenClient do
     end
   end
 
-  let (:client) { 
+  let (:client) {
 
     SirenClient.get(
-      url: URL, 
+      url: URL,
       timeout: 2,
       basic_auth: { username: 'admin', password: '1234' },
       headers: { "Accept" => "application/json" }
-    ) 
+    )
   }
   context 'when accessing the root entity' do
     it 'to return an entity' do
@@ -97,6 +97,21 @@ describe SirenClient do
       end
     end
   end
+  context 'when executing an action with DELETE' do
+    it 'returns a siren response' do
+      expect(client.delete_concept.where(id: 1)).to be_a SirenClient::Entity
+    end
+  end
+  # Typically this will be called directly on a resource
+  # without any additional parameters.
+  context 'when executing a `text/plain` action' do
+    it 'returns a 404 without the body being set correctly' do
+      expect { client.messages[0].update_message.submit }.to raise_error(/Code=404/)
+    end
+    it 'returns a siren response' do
+      expect(client.messages[0].update_message.where('this is the new message')).to be_a SirenClient::Entity
+    end
+  end
 
   let (:concepts) { SirenClient.get({ url: URL, basic_auth: { username: 'admin', password: '1234' }}).concepts }
   context 'when accessing an entity' do
@@ -123,6 +138,11 @@ describe SirenClient do
         client.filter_concepts_get.with_raw_response.where(params)
         expect(client.concepts).to be_a SirenClient::Entity
       end
+      it 'to return the correct concept' do
+        concepts_raw = client.filter_concepts_get.with_raw_response.where(params)
+        expect(concepts_raw.body).to match(/"count": 1/)
+        expect(concepts_raw.body).to match(/("text":"barack obama"){1}/)
+      end
     end
     it 'to provide the raw body' do
       expect(client.with_raw_response.concepts.body).to eq(HTTParty.get(URL + '/concepts', basic_auth: { username: 'admin', password: '1234' }).body)

data/spec/support/endpoints/concepts.rb

@@ -1,14 +1,15 @@
 class TestServer < Sinatra::Base
   CON_1 = <<-EOF
-    {  
+    {
       "class":["concepts"],
       "rel":["/rels/concepts"],
-      "properties":{  
+      "properties":{
+        "id": 1,
         "text":"barack obama",
         "category":"PERSON"
       },
-      "links":[  
-        {  
+      "links":[
+        {
           "rel":["self"],
           "href":"#{@@url}/concepts/1"
         }
@@ -16,15 +17,16 @@ class TestServer < Sinatra::Base
     }
   EOF
   CON_2 = <<-EOF
-    {  
+    {
       "class":["concepts"],
       "rel":["/rels/concepts"],
-      "properties":{  
+      "properties":{
+        "id": 2,
         "text":"tennessee",
         "category":"LOCATION"
       },
-      "links":[  
-        {  
+      "links":[
+        {
           "rel":["self"],
           "href":"#{@@url}/concepts/2"
         }
@@ -47,6 +49,14 @@ class TestServer < Sinatra::Base
       }
     EOF
   end
+  delete '/concepts/?' do
+    <<-EOF
+      {
+        "class":["status"],
+        "properties": { "success": true }
+      }
+    EOF
+  end
   get '/concepts/?' do
     query = (request.query_string.length > 0 ? '?' : '') + request.query_string
     # search=obama
@@ -66,14 +76,14 @@ class TestServer < Sinatra::Base
       EOF
     else
       <<-EOF
-        {  
+        {
           "class":["concepts","collection"],
-          "properties":{  
+          "properties":{
             "count":2
           },
           "entities":[#{CON_1}, #{CON_2}],
-          "links":[  
-            {  
+          "links":[
+            {
               "rel":["self"],
               "href":"#{@@url}/concepts#{query}"
             }

data/spec/support/endpoints/messages.rb

@@ -0,0 +1,73 @@
+class TestServer < Sinatra::Base
+  MSG_1 = <<-EOF
+    {
+      "class":["messages"],
+      "rel":["/rels/messages"],
+      "properties":{
+        "id": 1,
+        "text":"This is message one"
+      },
+      "links":[
+        {
+          "rel":["self"],
+          "href":"#{@@url}/messages/1"
+        }
+      ],
+      "actions": [{
+        "name": "update message",
+        "method": "PUT",
+        "href": "#{@@url}/messages/1",
+        "title": "Update the text of the message",
+        "type": "text/plain"
+      }]
+    }
+  EOF
+  MSG_2 = <<-EOF
+    {
+      "class":["messages"],
+      "rel":["/rels/messages"],
+      "properties":{
+        "id": 2,
+        "text":"This is message two"
+      },
+      "links":[
+        {
+          "rel":["self"],
+          "href":"#{@@url}/messages/2"
+        }
+      ],
+      "actions": [{
+        "name": "update message",
+        "method": "PUT",
+        "href": "#{@@url}/messages/2",
+        "title": "Update the text of the message",
+        "type": "text/plain"
+      }]
+    }
+  EOF
+  put '/messages/:id' do
+    if request.content_type == 'text/plain' &&
+       request.body.read == 'this is the new message'
+      MSG_1
+    else
+      halt 404
+    end
+  end
+  get '/messages/?' do
+    <<-EOF
+      {
+        "class":["messages","collection"],
+        "properties":{
+          "count":2
+        },
+        "entities":[#{MSG_1}, #{MSG_2}],
+        "links":[
+          {
+            "rel":["self"],
+            "href":"#{@@url}/messages"
+          }
+        ]
+      }
+    EOF
+  end
+end

data/spec/support/endpoints/root.rb

@@ -12,12 +12,12 @@ class TestServer < Sinatra::Base
             "href":"#{@@url}/"
           },
           {
-            "rel": ["collection", "concepts"], 
+            "rel": ["collection", "concepts"],
             "href":"#{@@url}/concepts",
             "title": "Concepts"
           },
           {
-            "rel": ["collection", "concepts with spaces"], 
+            "rel": ["collection", "concepts with spaces"],
             "href":"#{@@url}/concepts",
             "title": "Concepts"
           },
@@ -26,80 +26,68 @@ class TestServer < Sinatra::Base
             "title":"Messages"
           }
         ],
-        "actions": [  
-          {  
+        "actions": [
+          {
             "name":"filter-concepts-get",
             "method":"GET",
             "href":"#{@@url}/concepts",
             "title":"Get an optionally filtered list of Concepts",
             "type":"application/x-www-form-urlencoded",
-            "fields":[  
-              {  
+            "fields":[
+              {
                 "name":"limit",
                 "title":"Max number of results in each page",
                 "type":"number"
               },
-              {  
+              {
                 "name":"page",
                 "title":"Page number, starting at 1",
                 "type":"number"
               },
-              {  
+              {
                 "name":"search",
                 "title":"Keyword search on concept text",
                 "type":"text"
               }
             ]
           },
-          {  
+          {
+            "name": "delete-concept",
+            "method": "DELETE",
+            "href": "#{@@url}/concepts",
+            "title": "Delete a concept",
+            "type": "application/x-www-form-urlencoded",
+            "fields": [{
+              "name": "id",
+              "title": "ID of the concept to delete.",
+              "type": "text"
+            }]
+          },
+          {
             "name":"filter-concepts-post",
             "method":"POST",
             "href":"#{@@url}/concepts",
             "title":"Get an optionally filtered list of Concepts",
             "type":"application/x-www-form-urlencoded",
-            "fields":[  
-              {  
+            "fields":[
+              {
                 "name":"limit",
                 "title":"Max number of results in each page",
                 "type":"number"
               },
-              {  
+              {
                 "name":"page",
                 "title":"Page number, starting at 1",
                 "type":"number"
               },
-              {  
+              {
                 "name":"search",
                 "title":"Keyword search on concept text",
                 "type":"text"
               }
             ]
           },
-          { "name": "filter concepts post with spaces" },
-          {  
-            "name":"filter-messages",
-            "method":"GET",
-            "href":"#{@@url}/messages",
-            "title":"Get an optionally filtered list of Messages",
-            "type":"application/x-www-form-urlencoded",
-            "fields":[  
-              {  
-                "name":"limit",
-                "title":"Max number of results in each page",
-                "type":"number"
-              },
-              {  
-                "name":"page",
-                "title":"Page number, starting at 1",
-                "type":"number"
-              },
-              {  
-                "name":"search",
-                "title":"Keyword search on message body",
-                "type":"number"
-              }
-            ]
-          }
+          { "name": "filter concepts post with spaces" }
         ]
       }
     EOF

data/spec/unit/action_spec.rb

@@ -2,6 +2,8 @@ require 'helper/spec_helper'
 
 describe SirenClient::Action do
   let (:action_data) { {"name"=>"search","method"=>"GET","href"=>"http://example.com/products","fields"=>[{"name"=>"search","type"=>"text"}]} }
+  let (:action_data_post) { {"name"=>"search","method"=>"POST","href"=>"http://example.com/products","fields"=>[{"name"=>"search","type"=>"text"}]} }
+  let (:action_data_delete) { {"name"=>"delete","method"=>"DELETE","href"=>"http://example.com/products"} }
 
   describe '.new(data)' do
       it 'raise an error if wrong type is provided' do
@@ -12,11 +14,17 @@ describe SirenClient::Action do
       end
   end
 
-  let (:action) { 
-    SirenClient::Action.new(action_data, { 
-      headers: { "Accept" => "application/json" } 
+  let (:action) {
+    SirenClient::Action.new(action_data, {
+      headers: { "Accept" => "application/json" }
     })
   }
+  let (:action_post) {
+    SirenClient::Action.new(action_data_post)
+  }
+  let (:action_delete) {
+    SirenClient::Action.new(action_data_delete)
+  }
   describe '.config' do
     it 'is a hash' do
       expect(action.config).to be_a Hash
@@ -81,10 +89,22 @@ describe SirenClient::Action do
     end
   end
   describe '.where(params)' do
-    it 'executes the action without any parameters' do
+    it 'executes the GET action' do
+      # I'm expecting an error here, all I want to see is that the url it being traversed.
+      expect { action.where(test: 'hi') }.to raise_error SirenClient::InvalidResponseError
+    end
+    it 'executes the POST action' do
       # I'm expecting an error here, all I want to see is that the url it being traversed.
-      expect { action.where }.to raise_error SirenClient::InvalidResponseError
+      expect { action_post.where(test: 'hi') }.to raise_error SirenClient::InvalidResponseError
+    end
+    it 'executes the DELETE action' do
+      expect { action_delete.submit }.to raise_error SirenClient::InvalidResponseError
     end
     # The rest will be tested in the live specs.
   end
+  describe '.submit' do
+    it 'executes the action without any parameters' do
+      expect { action.submit }.to raise_error SirenClient::InvalidResponseError
+    end
+  end
 end

data/spec/unit/base_spec.rb

@@ -9,7 +9,7 @@ describe SirenClient do
       expect { SirenClient.get }.to raise_error(ArgumentError)
     end
     it "raise an error if an improper param is provided" do
-      expect { SirenClient.get([1, 2, 3]) }.to raise_error(ArgumentError, invalid_param_msg) 
+      expect { SirenClient.get([1, 2, 3]) }.to raise_error(ArgumentError, invalid_param_msg)
       expect { SirenClient.get(nil) }.to raise_error(ArgumentError, invalid_param_msg)
     end
     it "raise an error if no url is provided" do
@@ -22,31 +22,5 @@ describe SirenClient do
       expect { SirenClient.get('http://google.com') }.to raise_error(SirenClient::InvalidResponseError)
     end
   end
-  describe '.logger(before)' do
-    it 'is a standard ruby logger instance' do
-      expect(SirenClient.logger).to be_a Logger
-    end
-  end
-  describe '.logger=' do
-    it 'raise an error if it does not respect the logger interface' do
-      expect { SirenClient.logger = "error" }.to raise_error SirenClient::InvalidLogger
-    end
-    it 'accepts an instance that respects the logger interface' do
-      SirenClient.logger = Logger.new(STDOUT)
-      SirenClient.logger.level = Logger::WARN
-      expect(SirenClient.logger).to be_a Logger
-    end
-  end
-  describe '.logger(after)' do
-    it 'responds to .info(str)' do
-      expect(SirenClient.logger.respond_to?(:info)).to eq(true)
-    end
-    it 'responds to .warn(str)' do
-      expect(SirenClient.logger.respond_to?(:warn)).to eq(true)
-    end
-    it 'responds to .error(str)' do
-      expect(SirenClient.logger.respond_to?(:error)).to eq(true)
-    end
-  end
   # Remainder will be tested in live spec
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siren_client
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Chason Choate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-03-16 00:00:00.000000000 Z
+date: 2016-03-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -198,6 +198,7 @@ files:
 - spec/helper/spec_helper.rb
 - spec/live/traverse_spec.rb
 - spec/support/endpoints/concepts.rb
+- spec/support/endpoints/messages.rb
 - spec/support/endpoints/root.rb
 - spec/support/test_server.rb
 - spec/unit/action_spec.rb
@@ -226,7 +227,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: A client to traverse Siren APIs https://github.com/kevinswiber/siren
@@ -235,6 +236,7 @@ test_files:
 - spec/helper/spec_helper.rb
 - spec/live/traverse_spec.rb
 - spec/support/endpoints/concepts.rb
+- spec/support/endpoints/messages.rb
 - spec/support/endpoints/root.rb
 - spec/support/test_server.rb
 - spec/unit/action_spec.rb