siren_client 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4925d2e19eecb6f0cf7cc864099089e0b6f18fa3
-  data.tar.gz: f277ababef5cee15f59c437dd6c20e1b84873aa7
+  metadata.gz: 1d38e18a3d8e7b27a74a1bf4e39a87de411eba9b
+  data.tar.gz: 533cc402ef1239c82ccdac742caaaf9fb0dff276
 SHA512:
-  metadata.gz: 4532ad1cdb6fbab5ae42a02127ebba0ec2610268dde0bfbe62d0c07850704c35f93a45f79018ba81de54a623802665c7b0a49b7c94cef3dbd66637ebddceccc9
-  data.tar.gz: d71716ea6cad51b955cad7ec2b8c9467fa2d0a81f51056d49b9b0431314a5958895187ca26022b11fa41737f8d6f843569c23a0490afd736eb4b0564b50e90a5
+  metadata.gz: bc1e058531f13b91a3f043861407bda4a978a55566650a4f00f7de1043b2db8f9f150aba0c0852a47eae4caff867ac6da1888b39491c64fc638cd7e24ab58dd8
+  data.tar.gz: ee8785bd0cc1ee33529aebe40d2dea9eeee3b84635fb2623935033752296a889f50ac55750c0a5f4c523ef0a95249079867abbd21a7b1a9dedc73980be31a405

data/README.md

@@ -99,6 +99,38 @@ action.fields.each do |field|
 end
 ```
 
+## Accessing the raw response
+
+SirenClient can give you the raw response if needed. Some scenarios where this is useful:
+
+* When the API doesn't return a siren JSON structure.
+* Verifying response headers, status code, etc
+
+You can access the raw response with the following examples:
+
+```ruby
+root = SirentClient.get(...)
+
+# For sub-entities i.e. one named `test_concepts`
+root.with_raw_response.test_concepts
+
+# For links
+root.with_raw_response.concepts
+
+# For actions (this is different from the others)
+root.filter_concepts.with_raw_response.where(...)
+```
+
+Once you get the raw response instance you can call the following functions:
+
+```ruby
+raw.class == SirenClient::RawResponse
+raw.body # Returns the raw body of the response
+raw.code # Returns the HTTP status code
+raw.message # Returns the HTTP message i.e. "OK"
+raw.headers # A hash of the headers in the response
+```
+
 ## Development
 
 Run the following commands to start development:

data/lib/siren_client.rb

@@ -10,6 +10,8 @@ require 'active_support/core_ext/hash'
 
 # SirenClient files
 require "#{dir}/exceptions"
+require "#{dir}/raw_response"
+require "#{dir}/modules/with_raw_response"
 require "#{dir}/link"
 require "#{dir}/field"
 require "#{dir}/action"

data/lib/siren_client/action.rb

@@ -1,9 +1,12 @@
 module SirenClient
   class Action
+    include Modules::WithRawResponse
+
     attr_accessor :href
     attr_reader :payload, :name, :classes, :method, :title, :type, :fields, :config
 
     def initialize(data, config={})
+      super()
       if data.class != Hash
         raise ArgumentError, "You must pass in a Hash to SirenClient::Action.new"
       end
@@ -17,8 +20,8 @@ module SirenClient
       @title   = @payload['title']  || ''
       @type    = @payload['type']   || 'application/x-www-form-urlencoded'
       @fields  = @payload['fields'] || []
-      @fields.map! do |data|
-        SirenClient::Field.new(data)
+      @fields.map! do |field_data|
+        SirenClient::Field.new(field_data)
       end
     end
 
@@ -37,7 +40,12 @@ module SirenClient
           SirenClient.logger.debug "  #{k}: #{v}"
         end
         SirenClient.logger.debug '  ' + options[:body].to_query unless options[:body].empty?
-        Entity.new(HTTParty.send(@method.to_sym, @href, options).parsed_response, @config)
+        if next_response_is_raw?
+          disable_raw_response
+          generate_raw_response(self.href, @config)
+        else
+          Entity.new(HTTParty.send(@method.to_sym, @href, options).parsed_response, @config)
+        end
       rescue URI::InvalidURIError => e
         raise InvalidURIError, e.message
       rescue JSON::ParserError => e

data/lib/siren_client/entity.rb

@@ -1,16 +1,19 @@
 module SirenClient
   class Entity
     include Enumerable
+    include Modules::WithRawResponse
+
     attr_accessor :href
     attr_reader :payload, :classes, :properties, :entities, :rels,
                 :links, :actions, :title, :type, :config
 
 
     def initialize(data, config={})
+      super()
       @config = { format: :json }.merge config
       if data.class == String
         unless data.class == String && data.length > 0
-            raise InvalidURIError, 'An invalid url was passed to SirenClient::Entity.new.'
+          raise InvalidURIError, 'An invalid url was passed to SirenClient::Entity.new.'
         end
         begin
           SirenClient.logger.debug "GET #{data}"
@@ -21,9 +24,9 @@ module SirenClient
           raise InvalidResponseError, e.message
         end
       elsif data.class == Hash
-          @payload = data
+        @payload = data
       else
-          raise ArgumentError, "You must pass in either a url(String) or an entity(Hash) to SirenClient::Entity.new"
+        raise ArgumentError, "You must pass in either a url(String) or an entity(Hash) to SirenClient::Entity.new"
       end
       parse_data
     end
@@ -31,7 +34,16 @@ module SirenClient
     # Execute an entity sub-link if called directly
     # otherwise just return the entity.
     def [](i)
-      @entities[i].href.empty? ? @entities[i] : @entities[i].go rescue nil
+      if @entities[i].href.empty?
+        @entities[i]
+      else
+        if next_response_is_raw?
+          disable_raw_response
+          @entities[i].with_raw_response.go 
+        else 
+          @entities[i].go
+        end
+      end
     end
 
     def each(&block)
@@ -58,7 +70,12 @@ module SirenClient
     ### Entity sub-links only
     def go
       return if self.href.empty?
-      self.class.new(self.href, @config)
+      if next_response_is_raw?
+        disable_raw_response
+        generate_raw_response(self.href, @config)
+      else
+        self.class.new(self.href, @config)
+      end
     end
 
     def method_missing(method, *args)
@@ -70,22 +87,39 @@ module SirenClient
       end
       # Does it match an entity sub-link's class?
       @entities.each do |ent|
-        return ent.go if ent.href &&
-                         (ent.classes.map { |c| c.underscore }).include?(method_str.underscore)
+        if ent.href && (ent.classes.map { |c| underscore_name c }).include?(underscore_name(method_str))
+          if next_response_is_raw?
+            disable_raw_response
+            return ent.with_raw_response.go
+          else
+            return ent.go
+          end
+        end
       end
       # Does it match a link, if so traverse it and return the entity.
       @links.each do |key, link|
-        return link.go if method_str == key.underscore
+        if method_str == underscore_name(key)
+          if next_response_is_raw?
+            disable_raw_response
+            return link.with_raw_response.go
+          else
+            return link.go 
+          end
+        end
       end
       # Does it match an action, if so return the action.
       @actions.each do |key, action|
-        return action if method_str == key.underscore
+        return action if method_str == underscore_name(key)
       end
       raise NoMethodError, "The method \"#{method_str}\" does not match a property, action, or link on SirenClient::Entity."
     end
 
     private
 
+    def underscore_name(str)
+      str.underscore.gsub(' ', '_')
+    end
+
     def parse_data
       return if @payload.nil?
       @classes    = @payload['class']      || []

data/lib/siren_client/link.rb

@@ -1,9 +1,12 @@
 module SirenClient
   class Link
+    include Modules::WithRawResponse
+
     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
@@ -17,7 +20,12 @@ module SirenClient
     end
 
     def go
-      Entity.new(self.href, @config)
+      if next_response_is_raw?
+        disable_raw_response
+        generate_raw_response(self.href, @config)
+      else
+        Entity.new(self.href, @config)
+      end
     end
   end
 end

data/lib/siren_client/modules/with_raw_response.rb

@@ -0,0 +1,28 @@
+module SirenClient
+  module Modules
+    module WithRawResponse
+      def initialize
+        @_next_response_is_raw = false
+      end
+
+      def with_raw_response
+        @_next_response_is_raw = true
+        self
+      end
+
+      def disable_raw_response
+        @_next_response_is_raw = false
+      end
+
+      def next_response_is_raw?
+        @_next_response_is_raw
+      end
+
+      private 
+
+      def generate_raw_response(url, config)
+        RawResponse.new HTTParty.get(url, config)
+      end
+    end
+  end
+end

data/lib/siren_client/raw_response.rb

@@ -0,0 +1,26 @@
+module SirenClient
+  class RawResponse
+    def initialize(http_res)
+        unless http_res.class == HTTParty::Response
+          raise InvalidResponseError, "SirenClient::RawResponse expects a HTTParty::Response instance."
+        end
+        @response = http_res
+    end
+
+    def body
+      @response.body 
+    end
+
+    def code
+      @response.code
+    end
+
+    def message
+      @response.message.strip
+    end
+
+    def headers
+      @response.headers
+    end
+  end
+end

data/lib/siren_client/version.rb

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

data/spec/live/traverse_spec.rb

@@ -62,6 +62,9 @@ describe SirenClient do
       expect(client.concepts).to be_a SirenClient::Entity
       expect(client.concepts.links['self'].href).to eq(URL + '/concepts')
     end
+    it 'to follow the link with spaces' do
+      expect(client.concepts_with_spaces).to be_a SirenClient::Entity
+    end
   end
   context 'when accessing an action with GET' do
     it 'to return an action' do
@@ -81,6 +84,9 @@ describe SirenClient do
     it 'to return an action' do
       expect(client.filter_concepts_post).to be_a SirenClient::Action
     end
+    it 'to return an action with spaces' do
+      expect(client.filter_concepts_post_with_spaces).to be_a SirenClient::Action
+    end
     context 'with .where' do
       it 'to execute the action' do
         params = { search: 'obama' }
@@ -98,4 +104,40 @@ describe SirenClient do
       expect(concepts).to be_a SirenClient::Entity
     end
   end
+  context 'when accessing the raw response' do
+    context 'links' do
+      it 'to return a RawResponse instance' do
+        expect(client.with_raw_response.concepts).to be_a SirenClient::RawResponse
+      end
+      it 'to return an Entity on the second request' do
+        client.with_raw_response.concepts
+        expect(client.concepts).to be_a SirenClient::Entity
+      end
+    end
+    context 'actions' do
+      params = { search: 'obama' }
+      it 'to return a RawResponse instance' do
+        expect(client.filter_concepts_get.with_raw_response.where(params)).to be_a SirenClient::RawResponse
+      end
+      it 'to return an Entity on the second request' do
+        client.filter_concepts_get.with_raw_response.where(params)
+        expect(client.concepts).to be_a SirenClient::Entity
+      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)
+    end
+    it 'to provide the raw status code' do
+      expect(client.with_raw_response.concepts.code).to eq(200)
+    end
+    it 'to provide the raw message' do
+      expect(client.with_raw_response.concepts.message).to eq("OK")
+    end
+    it 'to provide the raw headers' do
+      expect(client.with_raw_response.concepts.headers).to include(
+        "content-type", "content-length", "server", "date", "connection"
+      )
+    end
+  end
+
 end

data/spec/support/endpoints/root.rb

@@ -16,6 +16,11 @@ class TestServer < Sinatra::Base
             "href":"#{@@url}/concepts",
             "title": "Concepts"
           },
+          {
+            "rel": ["collection", "concepts with spaces"], 
+            "href":"#{@@url}/concepts",
+            "title": "Concepts"
+          },
           { "rel": ["messages", "collection"],
             "href": "#{@@url}/messages",
             "title":"Messages"
@@ -70,6 +75,7 @@ class TestServer < Sinatra::Base
               }
             ]
           },
+          { "name": "filter concepts post with spaces" },
           {  
             "name":"filter-messages",
             "method":"GET",

data/spec/unit/entity_spec.rb

@@ -231,6 +231,19 @@ describe SirenClient::Entity do
       expect { entity.prev_page }.to raise_error Errno::ECONNREFUSED
     end
   end
+  describe '.with_raw_response' do
+    it 'returns the entity' do
+        expect(entity.with_raw_response).to eq(entity)
+    end
+    it 'sets the entity to return a raw response for the `next` request' do
+      entity.with_raw_response
+      expect(entity.next_response_is_raw?).to eq(true)
+    end
+    it 'should still allow a network request to be made' do
+      entity.with_raw_response
+      expect { entity.with_raw_response.prev_page }.to raise_error Errno::ECONNREFUSED
+    end
+  end
   # Entities enumerable support
   describe "enumerable support" do
     describe '.each' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: siren_client
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.0
 platform: ruby
 authors:
 - Chason Choate
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-02-17 00:00:00.000000000 Z
+date: 2016-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty
@@ -190,6 +190,8 @@ files:
 - lib/siren_client/exceptions.rb
 - lib/siren_client/field.rb
 - lib/siren_client/link.rb
+- lib/siren_client/modules/with_raw_response.rb
+- lib/siren_client/raw_response.rb
 - lib/siren_client/version.rb
 - siren_client.gemspec
 - spec/helper/live_spec_helper.rb
@@ -203,6 +205,7 @@ files:
 - spec/unit/entity_spec.rb
 - spec/unit/field_spec.rb
 - spec/unit/link_spec.rb
+- spec/unit/raw_response.rb
 homepage: https://github.com/cha55son/siren_client
 licenses:
 - MIT
@@ -239,3 +242,4 @@ test_files:
 - spec/unit/entity_spec.rb
 - spec/unit/field_spec.rb
 - spec/unit/link_spec.rb
+- spec/unit/raw_response.rb