pyr 0.3.3 → 0.3.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4208acf8b6be9c9d1b0d025ee817610501f8abf2
-  data.tar.gz: 880b3b112c64501d24859f04f74980f2366aa3cd
+  metadata.gz: 38e39c4009939ac2aeebaa972f147bf2d8cc9a75
+  data.tar.gz: 22fcfbe77d163fba7efdc6a9079ef9b7d0dda0f3
 SHA512:
-  metadata.gz: 8e3feeffe64379121dafa3dd21aa38eea4abb74c9c7c41771b3b561ebdf8a9e566fa9dc867403d465c07bcdba5cd746b918b49e74abb193ec2c96bbaacc3e442
-  data.tar.gz: b542e60905a65a8071f85860ac08833adf5ec604ab70ec67221fef8847fab14496a0372dbd9823b91589803f7e2aa4babaac84ea2c849c0467dfaa425313737e
+  metadata.gz: 4f93053da22ae238b21e805c366fd10eb672da945600bbac528ae92b7eb1a53e617027ea6c3cdddd321690260a3c22a3458828353cc84d73a0b1e7ff6021c91e
+  data.tar.gz: 78a38d8a378ca65c0291fd61832a7cdb5262c8db8a9c789a8c5e05de67e0d614f29642afee444ac1b093d6b02c7609eae9f96b2cfe738abfe8777400ec761600

data/README.md

@@ -51,7 +51,7 @@ response.body
 => { ... }
 
 reps = response.objects
-=> #<PYR::RepRelation [#<PYR::Rep id: 1, ...>]>
+=> #<PYR::RepRelation [#<PYR::Rep ...>]>
 
 reps.first.official_full
 => "Bernard Sanders"
@@ -84,10 +84,10 @@ reps.democratic.senators.count
 => 46
 
 reps.where official_full: 'Bernard Sanders'
-=> #<PYR::RepRelation [#<PYR::Rep id: 428, self: "https://phone-your-rep.herokuapp.com/api/beta/reps/S000033", state: #<PYR::State:0x007fdb11d42580>, district: nil, active: true, bioguide_id: "S000033", official_full: "Bernard Sanders", role: "United States Senator", party: "Independent", senate_class: "01", last: "Sanders", first: "Bernard", middle: nil, nickname: "Bernie", suffix: nil, contact_form: "http://www.sanders.senate.gov/contact/", url: "https://www.sanders.senate.gov", photo: "https://phoneyourrep.github.io/images/congress/450x550/S000033.jpg", twitter: "SenSanders", facebook: "senatorsanders", youtube: "senatorsanders", instagram: nil, googleplus: nil, twitter_id: "29442313", facebook_id: nil, youtube_id: "UCD_DaKNac0Ta-2PeHuoQ1uA", instagram_id: nil, office_locations_count: 3>]>
+=> #<PYR::RepRelation [#<PYR::Rep self: "https://phone-your-rep.herokuapp.com/api/beta/reps/S000033", state: #<PYR::State:0x007fdb11d42580>, district: nil, active: true, bioguide_id: "S000033", official_full: "Bernard Sanders", role: "United States Senator", party: "Independent", senate_class: "01", last: "Sanders", first: "Bernard", middle: nil, nickname: "Bernie", suffix: nil, contact_form: "http://www.sanders.senate.gov/contact/", url: "https://www.sanders.senate.gov", photo: "https://phoneyourrep.github.io/images/congress/450x550/S000033.jpg", twitter: "SenSanders", facebook: "senatorsanders", youtube: "senatorsanders", instagram: nil, googleplus: nil, twitter_id: "29442313", facebook_id: nil, youtube_id: "UCD_DaKNac0Ta-2PeHuoQ1uA", instagram_id: nil, office_locations_count: 3>]>
 
 reps.independent.where { |r| r.state.name == 'Vermont' }.first
-=> #<PYR::Rep id: 428, self: "https://phone-your-rep.herokuapp.com/api/beta/reps/S000033", state: #<PYR::State:0x007fdb11d42580>, district: nil, active: true, bioguide_id: "S000033", official_full: "Bernard Sanders", role: "United States Senator", party: "Independent", senate_class: "01", last: "Sanders", first: "Bernard", middle: nil, nickname: "Bernie", suffix: nil, contact_form: "http://www.sanders.senate.gov/contact/", url: "https://www.sanders.senate.gov", photo: "https://phoneyourrep.github.io/images/congress/450x550/S000033.jpg", twitter: "SenSanders", facebook: "senatorsanders", youtube: "senatorsanders", instagram: nil, googleplus: nil, twitter_id: "29442313", facebook_id: nil, youtube_id: "UCD_DaKNac0Ta-2PeHuoQ1uA", instagram_id: nil, office_locations_count: 3>
+=> #<PYR::Rep self: "https://phone-your-rep.herokuapp.com/api/beta/reps/S000033", state: #<PYR::State:0x007fdb11d42580>, district: nil, active: true, bioguide_id: "S000033", official_full: "Bernard Sanders", role: "United States Senator", party: "Independent", senate_class: "01", last: "Sanders", first: "Bernard", middle: nil, nickname: "Bernie", suffix: nil, contact_form: "http://www.sanders.senate.gov/contact/", url: "https://www.sanders.senate.gov", photo: "https://phoneyourrep.github.io/images/congress/450x550/S000033.jpg", twitter: "SenSanders", facebook: "senatorsanders", youtube: "senatorsanders", instagram: nil, googleplus: nil, twitter_id: "29442313", facebook_id: nil, youtube_id: "UCD_DaKNac0Ta-2PeHuoQ1uA", instagram_id: nil, office_locations_count: 3>
 ```
 
 ### Querying by ID
@@ -99,14 +99,14 @@ bernie = PYR.call(:reps, 'S000033').objects.first
 ### Querying by Object
 ```ruby
 office = PYR.reps('S000033').objects.first.office_locations.district.first
-=> #<PYR::OfficeLocation id: 1, city: "Burlington", rep: "https://phone-your-rep.herokuapp.com/api/beta/reps/S000033", active: true, office_id: "S000033-burlington", bioguide_id: "S000033", office_type: "district", distance: nil, building: "", address: "1 Church St.", suite: "3rd Floor", city: "Burlington", state: "VT", zip: "05401", phone: "802-862-0697", fax: "802-860-6370", hours: "", latitude: 44.4802081, longitude: -73.2130702, v_card_link: "https://phone-your-rep.herokuapp.com/v_cards/S000033-burlington", downloads: 14, qr_code_link: "https://s3.amazonaws.com/phone-your-rep-images/S000033_burlington.png">
+=> #<PYR::OfficeLocation city: "Burlington", rep: "https://phone-your-rep.herokuapp.com/api/beta/reps/S000033", active: true, office_id: "S000033-burlington", bioguide_id: "S000033", office_type: "district", distance: nil, building: "", address: "1 Church St.", suite: "3rd Floor", city: "Burlington", state: "VT", zip: "05401", phone: "802-862-0697", fax: "802-860-6370", hours: "", latitude: 44.4802081, longitude: -73.2130702, v_card_link: "https://phone-your-rep.herokuapp.com/v_cards/S000033-burlington", downloads: 14, qr_code_link: "https://s3.amazonaws.com/phone-your-rep-images/S000033_burlington.png">
 
 # Pass in the object itself as the param to PYR.call
-office.office_id == PYR.call(office).objects.first.office_id
+office == PYR.call(office).objects.first
 => true
 
 # Or use #call on the object itself
-office.office_id == office.call.objects.first.office_id
+office == office.call.objects.first
 => true
 ```
 
@@ -119,7 +119,7 @@ uri = rep.district.self
 
 district = PYR.call(uri).objects.first
 
-=> #<PYR::District id: 2, self: "https://phone-your-rep.herokuapp.com/api/beta/districts/5000", full_code: "5000", code: "00", state_code: "50">
+=> #<PYR::District self: "https://phone-your-rep.herokuapp.com/api/beta/districts/5000", full_code: "5000", code: "00", state_code: "50">
 ```
 
 ## Development

data/lib/pyr.rb

@@ -69,8 +69,10 @@ require 'pyr/version'
 #
 #   PYR.reps('S000033').objects.first.official_full # => "Bernard Sanders"
 #
-# Any of the following resources can be passed as the first argument to `PYR.call`,
-# or called as a class method directly to the PYR module, as in the above example.
+# Any of the following resources can be passed as the first argument to
+# `PYR.call`, or called as a class method directly to the PYR module,
+# as in the above example.
+#
 # Both options yield a resource to the block for setting params.
 #   :reps, :office_locations, :states, :districts, :zctas
 #
@@ -115,12 +117,14 @@ module PYR
   #
   # Arguments can be:
   #
-  # a particular PYR::ResponseObject itself to query that object's 'self' url;
+  # * 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;
   #
-  # a valid Phone Your Rep URI beginning with the API_BASE_URI string value;
+  # * or, perhaps most commonly, a resource name (String or Symbol) with
+  #   optional ID(String).
   #
-  # or, perhaps most commonly, a resource name (String or Symbol) with
-  # optional ID(String).
+  # @return [Response]
   def self.call(resource, id = nil, &config_block)
     if resource.is_a?(ResponseObject)
       request_object = { response_object: resource }
@@ -136,35 +140,50 @@ module PYR
 
   # Call the :reps resource.
   #
+  # @example
   #   PYR.reps { |r| r.address = '123 Main St, USA 12345' }
+  #
+  # @return [PYR::Response]
   def self.reps(id = nil, &config_block)
     call(:reps, id, &config_block)
   end
 
   # Call the :office_locations resource.
   #
+  # @example
   #   PYR.office_locations { |r| r.address = '123 Main St, USA 12345' }
-  def self.office_locations(id=nil, &config_block)
+  #
+  # @return [PYR::Response]
+  def self.office_locations(id = nil, &config_block)
     call(:office_locations, id, &config_block)
   end
 
   # Call the :zctas resource.
   #
+  # @example
   #   PYR.zctas('90026') { |r| r.reps = true }
+  #
+  # @return [PYR::Response]
   def self.zctas(id = nil, &config_block)
     call(:zctas, id, &config_block)
   end
 
   # Call the :states resource.
   #
+  # @example
   #   PYR.states '50'
+  #
+  # @return [PYR::Response]
   def self.states(id = nil, &config_block)
     call(:states, id, &config_block)
   end
 
   # Call the :districts resource.
   #
+  # @example
   #   PYR.districts '5000'
+  #
+  # @return [PYR::Response]
   def self.districts(id = nil, &config_block)
     call(:districts, id, &config_block)
   end

data/lib/pyr/version.rb

@@ -1,6 +1,5 @@
 # frozen_string_literal: true
 
-
 module PYR
-  VERSION = '0.3.3' # :nodoc:
+  VERSION = '0.3.4' # :nodoc:
 end

data/pyr.gemspec

@@ -37,6 +37,6 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3.0'
   spec.add_dependency 'faraday', '~> 0.12.0'
   spec.add_dependency 'faraday_middleware', '~> 0.11.0'
-  spec.add_dependency 'lazy_record', '~> 0.4.0'
+  spec.add_dependency 'lazy_record', '~> 0.6.0'
   spec.add_development_dependency 'bundler', '~> 1.14'
 end

metadata

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