parliament-ruby 0.6.2 → 0.6.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1b45e08c7fa2e28c6b5f0c7b9d754cb7cc51449a
-  data.tar.gz: 3e76b4cb267bbd1c5a8bea9e2488dc96e93bd513
+  metadata.gz: 581a69e9850b75eef39d684fd40f5347ebcf8bb1
+  data.tar.gz: f28f46585c4dc4cfd9f14735918804e184367d4f
 SHA512:
-  metadata.gz: 7c4f920226cdb58e1f9931fe1768d119762268f89238808491e2c2cfc014ac776e6477c21062a5b44d6beed69b384cd4cd985c8da57f6c8faf338bb592253ca2
-  data.tar.gz: 8cfac53fe11fe6306a5dbe1750d2f89ddd535e1d7b01b644fe600ece78b5adc800335bb3c712f5c7687ae89e88306171b9f265355a596c50c940df3753065ac5
+  metadata.gz: 5e1f64b23a425ee4e1b9c4a816eeb1f583a7c84a382010b0da35c6ef2dfcb5fc5ea0fc5a4bb23764b8b50650edcb5985b718e918bca9b3192137543930d9217c
+  data.tar.gz: '08882fbca6ac37527cd83420cb0a6d1a8bbf120db74e73ebdc8114548b40110d988948fdeaf37c97e803f5d791adf15d81d0cf8a7813080462cfe6b9d9c35cc8'

data/README.md

@@ -98,7 +98,19 @@ parliament.parties('123').people.current
 parliament.people('123').letters('456')
 ```
 
+### Setting headers
 
+#### Setting headers 'globally'
+Within the code you can set global headers using the following snippet.
+```
+Parliament::Request.headers = { 'Accept' => 'Test' }
+
+# The headers should be set for all new objects
+Parliament::Request.new.headers #=> { 'Accept' => 'Test' }
+
+# You can still override the headers on an instance by instance basis
+Parliament::Request.new(headers: { 'Accept' => 'Test2' }).headers #=> { 'Accept' => 'Test2' }
+```
 ### Methods
 [parliament-ruby][parliament-ruby] comes with the following common methods:
 

data/lib/parliament/request.rb

@@ -5,14 +5,15 @@ module Parliament
   # @since 0.1.0
   #
   # @attr_reader [String] base_url the base url of our api. (expected: http://example.com - without the trailing slash).
+  # @attr_reader [Hash] headers the headers being sent in the request.
   class Request
-    attr_reader :base_url
+    attr_reader :base_url, :headers
 
     # Creates a new instance of Parliament::Request.
     #
     # An interesting note for #initialize is that setting base_url on the class, or using the environment variable
     # PARLIAMENT_BASE_URL means you don't need to pass in a base_url. You can pass one anyway to override the
-    # environment variable or class parameter.
+    # environment variable or class parameter.  Similarly, headers can be set by either settings the headers on the class, or passing headers in.
     #
     # @example Setting the base_url on the class
     #   Parliament::Request.base_url = 'http://example.com'
@@ -35,10 +36,27 @@ module Parliament
     #
     #   Parliament::Request.new(base_url: 'http://example.com').base_url #=> 'http://example.com'
     #
+    # @example Setting the headers on the class
+    #   Parliament::Request.headers = { 'Accept' => 'Test' }
+    #
+    #   Parliament::Request.new.headers #=> '{ 'Accept' => 'Test' }
+    #
+    # @example Setting the headers via a parameter
+    #   Parliament::Request.headers #=> nil
+    #
+    #   Parliament::Request.new(headers: '{ 'Accept' => 'Test' }).headers #=> { 'Accept' => 'Test' }
+    #
+    # @example Overriding the headers via a parameter
+    #   Parliament::Request.headers = { 'Accept' => 'Test' }
+    #
+    #   Parliament::Request.new(headers: '{ 'Accept' => 'Test2' }).headers #=> { 'Accept' => 'Test2' }
+    #
     # @param [String] base_url the base url of our api. (expected: http://example.com - without the trailing slash).
-    def initialize(base_url: nil)
+    # @param [Hash] headers the headers being sent in the request.
+    def initialize(base_url: nil, headers: nil)
       @endpoint_parts = []
       @base_url = base_url || self.class.base_url || ENV['PARLIAMENT_BASE_URL']
+      @headers = headers || self.class.headers || {}
     end
 
     # Overrides ruby's method_missing to allow creation of URLs through method calls.
@@ -113,7 +131,7 @@ module Parliament
 
       net_response = http.start do |h|
         api_request = Net::HTTP::Get.new(endpoint_uri.request_uri)
-        api_request.add_field('Accept', 'application/n-triples')
+        add_headers(api_request)
 
         h.request api_request
       end
@@ -126,8 +144,20 @@ module Parliament
     private
 
     # @attr [String] base_url the base url of our api. (expected: http://example.com - without the trailing slash).
+    # @attr [Hash] headers the headers being sent in the request.
     class << self
-      attr_accessor :base_url
+      attr_accessor :base_url, :headers
+    end
+
+    def default_headers
+      { 'Accept' => 'application/n-triples' }
+    end
+
+    def add_headers(request)
+      headers = default_headers.merge(@headers)
+      headers.each do |key, value|
+        request.add_field(key, value)
+      end
     end
 
     def api_endpoint

data/lib/parliament/version.rb

@@ -1,3 +1,3 @@
 module Parliament
-  VERSION = '0.6.2'.freeze
+  VERSION = '0.6.3'.freeze
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: parliament-ruby
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.6.3
 platform: ruby
 authors:
 - Matt Rayner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-03-29 00:00:00.000000000 Z
+date: 2017-03-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: grom