pyr 0.2.6 → 0.2.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ea77ac4b5fe041319a0edff8e173cb200ea4f4f0
-  data.tar.gz: 8a988b40f80559222bce3a60697c96c5272b770f
+  metadata.gz: 914f50257dbe7dc3ae66aaf21f42ad22a55e5159
+  data.tar.gz: 06f70f5b276a4255fb2447bde72b7a93908fddaf
 SHA512:
-  metadata.gz: 1f74b966917b39d84d78d4bfa85f0019aafab98d8bac66eb558687fca72ad6ce68ed23b20de280178a83611839b5e3dec29ad726adcb211772f1acc1c2c48917
-  data.tar.gz: 3dbb8631337eb18f10010626a9e788961d62c22f64c1926857b0f05652f14a942cf2a6eeba7414cc4c3c18d03b5e349626801c04aabca9279cc1be595311dbbc
+  metadata.gz: 379d5b802899fa9bf3d6e1005cc4088229903650a1fe8c655a302f6ee21736cc2c1a2709adb36df912b7a5b9675bf6a8c0ec8491bdae3db584986e7975d5e80b
+  data.tar.gz: 30a81749f5c73352238d337a3861cc70def6da50420e3f02ac1b77fc92dafcf1d8e4f5c443c5570a33069fa8aa873cf2845fed68f548755b11cb688adccd2378

data/lib/pyr.rb

@@ -155,7 +155,7 @@ module PYR
     if resource.is_a?(ResponseObject)
       request_object = { response_object: resource }
     elsif resource.to_s.include? API_BASE_URI
-      request_object = { base_url: resource }
+      request_object = { uri: resource }
     else
       resource = Request.build(resource, id)
       yield resource if block_given?

data/lib/pyr/response.rb

@@ -2,25 +2,58 @@
 
 module PYR
   # The object returned by a request call to the API.
+  # == Example
+  #     response = PYR.call :reps, 'S000033'
+  #     # => #<PYR::Response:0x007fe8f90829f8 ... >
   class Response
-    attr_reader :body, :path, :code, :reason_phrase, :headers, :objects, :controller
+    # Returns a hash of the Raw JSON response
+    # == Example
+    #     response.body # => { ... }
+    attr_reader :body
+    # Returns a string of the URI path
+    # == Example
+    #     response.path # => 'reps/S000033'
+    attr_reader :path
+    # Returns an integer of the  HTTP status code
+    # == Example
+    #     response.code # => 200
+    attr_reader :code
+    # Returns a string of the response HTTP reason phrase
+    # == Example
+    #     response.reason_phrase # => "OK"
+    attr_reader :reason_phrase
+    # Returns a hash of the response HTTP headers
+    # == Example
+    #     response.headers # => {"server"=>"Cowboy", "connection"=>"close", ... }
+    attr_reader :headers
+    # Returns a collection of PYR::ResponseObjects representing API objects
+    # == Example
+    #     response.objects
+    #     # => #<PYR::RepRelation [#<PYR::Rep ... >]>
+    #     response.objects.first.office_locations
+    #     # => #<PYR::OfficeLocationRelation [#<PYR::OfficeLocation ... >]>
+    attr_reader :objects
+    # Returns a symbol representing the Responding API controller
+    # == Example
+    #     response.controller # => :reps
+    attr_reader :controller
 
-    def initialize(base_url: nil, resource: nil, response_object: nil)
-      assign_url_and_controller(base_url, resource, response_object)
+    def initialize(uri: nil, resource: nil, response_object: nil)
+      assign_url_and_controller(uri, resource, response_object)
       fetch_and_parse_payload
       parse_objects
     end
 
-    def assign_url_and_controller(base_url, resource, response_object)
+    def assign_url_and_controller(uri, resource, response_object)
       if resource
         @controller = resource.controller
-        @path        = resource.to_s
-      elsif base_url
-        @controller = base_url.sub!(API_BASE_URI, '').split('/').first
-        @path        = base_url
+        @path       = resource.to_s
+      elsif uri
+        @controller = uri.sub!(API_BASE_URI, '').split('/').first
+        @path       = uri
       elsif response_object
         @controller = response_object.controller
-        @path        = response_object.self.sub(API_BASE_URI, '')
+        @path       = response_object.self.sub(API_BASE_URI, '')
       end
     end
 

data/lib/pyr/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module PYR
-  VERSION = '0.2.6' # :nodoc:
+  VERSION = '0.2.7' # :nodoc:
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pyr
 version: !ruby/object:Gem::Version
-  version: 0.2.6
+  version: 0.2.7
 platform: ruby
 authors:
 - M. Simon Borg