open_parliament 0.0.1 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9de4e102a3a94c16f5d5f67ef60e162c1912c764
-  data.tar.gz: 1f875edbdb4bdd1a1df019eb54f4d480450f2fb1
+  metadata.gz: 3c3aedb0b5ca2f066d7af2cd90f96b18ad392f8a
+  data.tar.gz: 5a6994212e32c030b8dd19102c5252af1ae783e8
 SHA512:
-  metadata.gz: b711db89f02bbe026522ac11df413c2cb59d8ebcf9bac647ee2f4a2c4c9929e774a89831a7c15a7afffe0caa347a531998be5c62d3ded77cea7f4a6a40845283
-  data.tar.gz: 7cb6bae102a1c716b5544551a978c565b0a108e19ede2ecb9da251120f7ec14031ece0e1072e7bd63648bec247412f807264a0660a5d6fe26fac55b60d451b20
+  metadata.gz: e4c10bbf28368847002d4fb8a2ce1099a69adcfbdcca977e03d173d8e2cee78b4751d1eb71a863269f2161b59513010142d165f4b83700a1d06a5fc0c61016f4
+  data.tar.gz: 0c32439aea2fb125d566c7d9d9d4525c03b888f9bba841d4c1104ba466ed0e365682a405ee19440ae808818d6134078963fdb91b05fe83b007855aad970ade5a

data/Gemfile.lock

@@ -3,15 +3,15 @@ GEM
   specs:
     coderay (1.1.0)
     diff-lcs (1.2.5)
-    domain_name (0.5.24)
+    domain_name (0.5.25)
       unf (>= 0.0.5, < 1.0.0)
     http-cookie (1.0.2)
       domain_name (~> 0.5)
     json (1.8.3)
     method_source (0.8.2)
-    mime-types (2.6.1)
-    netrc (0.10.3)
-    pry (0.10.1)
+    mime-types (2.99)
+    netrc (0.11.0)
+    pry (0.10.3)
       coderay (~> 1.1.0)
       method_source (~> 0.8.1)
       slop (~> 3.4)

data/README.md

@@ -6,7 +6,7 @@ A simple gem to interface with the api at https://openparliament.ca/api/
 Currently supports basic GETs of 5 endpoints: Bills, Committees, Debates, Politicians, and Votes. These endpoints return lists of OpenParliament objects (which are currently just OpenStructs).
 
 ##Usage
-```
+```ruby
 gem install open_parliament
 
 require 'open_parliament'
@@ -22,4 +22,8 @@ OpenParliament.votes => [OpenParliament::Vote...]
 vote = OpenParliament.votes.first
 vote.result => "Passed"
 vote.description["en"] => "That the Bill be now read a third time and do pass."
+
+# Pagination with limit/offset. Defaults to limit:20, offset:0
+first_bill = OpenParliament.bills(limit: 1)
+second_bill = OpenParliament.bills(limit: 1, offset: 1)
 ```

data/lib/open_parliament.rb

@@ -13,37 +13,37 @@ require 'open_parliament/request_service'
 module OpenParliament
   API_URL = 'http://api.openparliament.ca'
 
-  def self.bills
+  def self.bills(params = {})
     url = "/bills/"
-    json = RequestService.make_request(url: url, method: :get)
+    json = RequestService.make_request(url: url, method: :get, params: params)
     bills = json["objects"]
     bills.map { |bill_json| Bill.new(bill_json) }
   end
 
-  def self.committees
+  def self.committees(params = {})
     url = "/committees/"
-    json = RequestService.make_request(url: url, method: :get)
+    json = RequestService.make_request(url: url, method: :get, params: params)
     committees = json["objects"]
     committees.map { |committee_json| Committee.new(committee_json) }
   end
 
-  def self.debates
+  def self.debates(params = {})
     url = "/debates/"
-    json = RequestService.make_request(url: url, method: :get)
+    json = RequestService.make_request(url: url, method: :get, params: params)
     debates = json["objects"]
     debates.map { |debate_json| Debate.new(debate_json) }
   end
 
-  def self.votes
+  def self.votes(params = {})
     url = "/votes/"
-    json = RequestService.make_request(url: url, method: :get)
+    json = RequestService.make_request(url: url, method: :get, params: params)
     votes = json["objects"]
     votes.map { |vote_json| Vote.new(vote_json) }
   end
 
-  def self.politicians
+  def self.politicians(params = {})
     url = "/politicians/"
-    json = RequestService.make_request(url: url, method: :get)
+    json = RequestService.make_request(url: url, method: :get, params: params)
     politicians = json["objects"]
     politicians.map { |politician_json| Politician.new(politician_json) }
   end

data/lib/open_parliament/request_service.rb

@@ -1,16 +1,37 @@
 module OpenParliament
   module RequestService
 
+    VALID_PARAMS = [:limit, :offset]
+
     def self.make_request(url:, method:, params: {})
       full_url = "#{OpenParliament::API_URL}#{url}"
 
       resp = RestClient::Request.execute(method: method, 
                                          url: full_url,
                                          timeout: 10,
-                                         headers: { accept: :json }
+                                         headers: build_headers(params),
                                          )
       JSON.parse(resp)
     end
 
+    def self.build_headers(params)
+      {
+        "API-Version" => "v1",
+        accept: :json,
+        params: build_params(params),
+      }
+    end
+
+    def self.build_params(params)
+      allowed_params = params.select { |k| VALID_PARAMS.include?(k) }
+      default_params.merge(allowed_params)
+    end
+
+    def self.default_params
+      {
+        limit: 20,
+        offset: 0,
+      }
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: open_parliament
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.1.0
 platform: ruby
 authors:
 - Dylan Runkel