pyr 0.3.5 → 0.3.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 06dabb456b098d36fcdd56f8e2ca411081cdb6d9
-  data.tar.gz: e09dc5d6924736a814728202502dcfb7914b069f
+  metadata.gz: 3cd5d4b0396c09ef15ce17149ddc2630c0a7be0b
+  data.tar.gz: 23862f7073f6ce87b2d4b7dd499ba69484c55eba
 SHA512:
-  metadata.gz: 97b7a826450b221c83eee3695bc9d942a9b1930b21f3ac751e872305ca246ecf9a546b3761adf3d941a9cf401a4e837ba6a49e26f0059befce4625e27d8a4692
-  data.tar.gz: 14f9b4d09aaf1c2b260db07c54684e590f076ab7337da24d6183d011481653c539a84a747d2c9508938638b5bb458bd5d0825c264bbe1dda517623055b9df3ff
+  metadata.gz: 9ed8f194ac9d6a9f7da98603875a19a4a96adb6107b3e7b04954f1289fb28e0f0691507bfd3f43a2cbe3dd6f4bc94ea432c13ae7f859a0ca4a43b04b8ac79093
+  data.tar.gz: ccca4b7c35d5995d5d888418f204b5bbbd9392ce350b18d45ce4e5ef914e3fb0124ae767d647f4e82c65395d1b0c4cdc99fe7b7b63517c855e856ce5b2eb964a

data/README.md

@@ -1,5 +1,9 @@
 # PYR
+[![Gem Version](https://badge.fury.io/rb/pyr.svg)](https://badge.fury.io/rb/pyr)
 [![Code Climate](https://codeclimate.com/github/msimonborg/pyr/badges/gpa.svg)](https://codeclimate.com/github/msimonborg/pyr)
+[![Coverage Status](https://coveralls.io/repos/github/msimonborg/pyr/badge.svg?branch=master)](https://coveralls.io/github/msimonborg/pyr?branch=master)
+[![Build Status](https://travis-ci.org/msimonborg/pyr.svg?branch=master)](https://travis-ci.org/msimonborg/pyr)
+[![Inline docs](http://inch-ci.org/github/msimonborg/pyr.svg?branch=master)](http://inch-ci.org/github/msimonborg/pyr)
 
 PYR makes integrating data from the [Phone Your Rep API](https://www.github.com/phoneyourrep/phone-your-rep-api) into your Ruby project as easy as pie.
 
@@ -122,6 +126,17 @@ district = PYR.call(uri).objects.first
 => #<PYR::District self: "https://phone-your-rep.herokuapp.com/api/beta/districts/5000", full_code: "5000", code: "00", state_code: "50">
 ```
 
+## Platform support
+
+Tested against:
+* MRI 2.3.0
+* MRI 2.3.4
+* MRI 2.4.1
+* JRuby 9.1.6.0
+* Rubinius 3.74
+* JRuby HEAD
+* MRI HEAD
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pyr.rb

@@ -112,43 +112,66 @@ module PYR
     inflect.irregular 'zcta', 'zctas'
   end
 
-  # The main API interface. All the objects you will need to work
-  # with are returned by this method.
+  # Main interface to the API, specify a resource, optional ID, and params
   #
-  # Arguments can be:
+  # @param resource [Symbol, String]
+  # @param id [String]
   #
-  # * a particular PYR::ResponseObject itself to query that object's 'self' url;
-  #
-  # * a valid Phone Your Rep URI beginning with the API_BASE_URI string value;
+  # @return [PYR::Response]
   #
-  # * or, perhaps most commonly, a resource name (String or Symbol) with
-  #   optional ID(String).
+  # @api public
   #
-  # @return [Response]
+  # @example
+  #   PYR.call(:zctas, '90026') { |req| req.reps = true }
   def self.call(resource, id = nil, &config_block)
-    if resource.is_a?(ResponseObject)
-      request_object = { response_object: resource }
-    elsif resource.to_s.include? API_BASE_URI
-      request_object = { uri: resource }
-    else
-      resource = Request.build(resource, id)
-      config_block.call resource if block_given?
-      request_object = { resource: resource }
-    end
-    Response.new request_object
+    resource = Request.build(resource, id)
+    config_block.call resource if block_given?
+    Response.new(resource: resource)
+  end
+
+  # Query the API by a valid Phone Your Rep URI
+  #
+  # @example
+  #   PYR.uri("#{PYR::BASE_URI.dup}reps/S000033") # => #<PYR::Response ... >
+  #
+  # @return [PYR::Response]
+  #
+  # @param uri [String]
+  #
+  # @api public
+  def self.uri(uri)
+    Response.new(uri: uri)
+  end
+
+  # Query the API by passing a PYR::ResponseObject
+  #
+  # @example
+  #   object = PYR.call(:reps, 'S000033').objects.first # => #<PYR::Rep ... >
+  #   other_object = PYR.object(object).objects.first # => #<PYR::Rep ... >
+  #   object == other_object # => true
+  #
+  # @return [PYR::Response]
+  #
+  # @param object [PYR::ResponseObject]
+  #
+  # @api public
+  def self.object(object)
+    Response.new(response_object: object)
   end
 
-  # Call the :reps resource.
+  # Call the :reps resource
   #
   # @example
   #   PYR.reps { |r| r.address = '123 Main St, USA 12345' }
   #
+  # @api public
+  #
   # @return [PYR::Response]
   def self.reps(id = nil, &config_block)
     call(:reps, id, &config_block)
   end
 
-  # Call the :office_locations resource.
+  # Call the :office_locations resource
   #
   # @example
   #   PYR.office_locations do |r|
@@ -156,36 +179,44 @@ module PYR
   #     r.radius = 50
   #   end
   #
+  # @api public
+  #
   # @return [PYR::Response]
   def self.office_locations(id = nil, &config_block)
     call(:office_locations, id, &config_block)
   end
 
-  # Call the :zctas resource.
+  # Call the :zctas resource
   #
   # @example
   #   PYR.zctas('90026') { |r| r.reps = true }
   #
+  # @api public
+  #
   # @return [PYR::Response]
   def self.zctas(id = nil, &config_block)
     call(:zctas, id, &config_block)
   end
 
-  # Call the :states resource.
+  # Call the :states resource
   #
   # @example
   #   PYR.states '50'
   #
+  # @api public
+  #
   # @return [PYR::Response]
   def self.states(id = nil, &config_block)
     call(:states, id, &config_block)
   end
 
-  # Call the :districts resource.
+  # Call the :districts resource
   #
   # @example
   #   PYR.districts '5000'
   #
+  # @api public
+  #
   # @return [PYR::Response]
   def self.districts(id = nil, &config_block)
     call(:districts, id, &config_block)

data/lib/pyr/resource.rb

@@ -33,6 +33,8 @@ module PYR
       "#{controller}#{id}?#{params.map(&:to_s).join('&')}"
     end
 
+    private
+
     def params
       @params ||= []
     end

data/lib/pyr/response.rb

@@ -49,8 +49,8 @@ module PYR
         @controller = resource.controller
         @path       = resource.to_s
       elsif uri
-        @controller = uri.sub!(API_BASE_URI, '').split('/').first
-        @path       = uri
+        @path       = uri.sub(API_BASE_URI, '')
+        @controller = @path.split('/').first
       elsif response_object
         @controller = response_object.controller
         @path       = response_object.self.sub(API_BASE_URI, '')

data/lib/pyr/response_object.rb

@@ -23,14 +23,23 @@ module PYR
       super(new_opts, &block)
     end
 
-    # The controller name, based on the object's class name.
+    # The controller name, based on the object's class name
     def controller
       @controller ||= self.class.to_s.split('::').last.tableize
     end
 
-    # Send a request to the API for the object.
+    # Send a request to the API for the object
+    #
+    # @example
+    #   object = PYR.call(:reps, 'S000033').objects.first # => #<PYR::Rep ... >
+    #   res = object.call # => #<PYR::Response ... >
+    #   object == res.objects.first # => true
+    #
+    # @return [PYR::Response]
+    #
+    # @api public
     def call
-      PYR.call self
+      PYR.object self
     end
 
     private

data/lib/pyr/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pyr
 version: !ruby/object:Gem::Version
-  version: 0.3.5
+  version: 0.3.6
 platform: ruby
 authors:
 - M. Simon Borg
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-18 00:00:00.000000000 Z
+date: 2017-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: 0.6.2
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement