parliament-ruby 0.7.4 → 0.7.5.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 72c73709b14ab1591a287636e7735c9758de56da
-  data.tar.gz: 14aaef8e1f7233189d8f99488ea4ecfe740341a2
+  metadata.gz: 0a79edd03b21e7446afd20f132813f37b09cfacc
+  data.tar.gz: dfbc9570cea9cc014855cb05ffd0aa763f47edde
 SHA512:
-  metadata.gz: 13f59fb73e8b3078dc74b8899fd39ddf0c8d013cfb0ab8c4a005d216e275fe18ea266f10337ad46a1ff86a0be2bb17e49cb4e9f86661d9f6d028e91041e30689
-  data.tar.gz: cc3d3831a3a52395f0bfb979f06fcfc56f47c36d589493ca79aa25597dcac4e3da5bb7463852d3696b810410398ac0ae3e50157d231434f26164b81c79d27de8
+  metadata.gz: d75ea0f2608a5ad2adf3f9860d7b22c640d631f1b8b3ef6e47f522433e9e6ee5c2025bbd74c773e23f333e1ee6c5378d526c5eabc5435fdba43278c132b345ce
+  data.tar.gz: 876e757ac2e8dfcdda1bbc8f336301f043b340549c670a7a62622d5d8fc11464b27de3d63f5f9e9ba2bf418e97f9cc681782b75aa87886ca3e73b79ceb731fea

data/lib/parliament.rb

@@ -1,11 +1,8 @@
 require 'net/http'
-require 'grom'
 
 require 'parliament/version'
 require 'parliament/request'
 require 'parliament/response'
-require 'parliament/utils'
-require 'parliament/decorator'
 require 'parliament/builder'
 
 require 'parliament/network_error'

data/lib/parliament/builder.rb

@@ -3,6 +3,5 @@ module Parliament
   # @since 0.7.0
   module Builder
     require 'parliament/builder/base_response_builder'
-    require 'parliament/builder/ntriple_response_builder'
   end
 end

data/lib/parliament/builder/base_response_builder.rb

@@ -1,12 +1,21 @@
 module Parliament
   module Builder
+    # Base response builder, allowing the user to return the body of an HTTPResponse.
+    # @since 0.7.5
     class BaseResponseBuilder
-      def initialize(response)
+      # Creates a new BaseReponseBuilder.
+      # @param [HTTPResponse] response an HTTP response.
+      # @param [Module] decorators a namespace which contains modules used to decorate the objects we receive.  It is not used directly by the BaseResponseBuilder, but is there for API completeness.
+      def initialize(response:, decorators: nil)
         @response = response
+        _ = decorators
       end
 
+      # Builds a Parliament::Response::BaseResponse.
+      #
+      # @return [Parliament::Response::Base::Response] a Parliament::Response::BaseResponse containing the HTTPResponse.
       def build
-        @response
+        Parliament::Response::BaseResponse.new(@response)
       end
     end
   end

data/lib/parliament/request/base_request.rb

@@ -1,78 +1,89 @@
 module Parliament
   module Request
+    # Base request object, allowing the user to make a request to an API.
+    #
+    # @since 0.7.5
+    #
+    # @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 BaseRequest
       attr_reader :base_url, :headers
-      # Creates a new instance of Parliament::Request.
+      # Creates a new instance of Parliament::Request::BaseRequest.
       #
       # 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.  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'
+      #   Parliament::Request::BaseRequest.base_url = 'http://example.com'
       #
-      #   Parliament::Request.new.base_url #=> 'http://example.com'
+      #   Parliament::Request::BaseRequest.new.base_url #=> 'http://example.com'
       #
       # @example Setting the base_url via environment variable
       #   ENV['PARLIAMENT_BASE_URL'] #=> 'http://test.com'
       #
-      #   Parliament::Request.new.base_url #=> 'http://test.com'
+      #   Parliament::Request::BaseRequest.new.base_url #=> 'http://test.com'
       #
       # @example Setting the base_url via a parameter
-      #   Parliament::Request.base_url #=> nil
+      #   Parliament::Request::BaseRequest.base_url #=> nil
       #   ENV['PARLIAMENT_BASE_URL'] #=> nil
       #
-      #   Parliament::Request.new(base_url: 'http://example.com').base_url #=> 'http://example.com'
+      #   Parliament::Request::BaseRequest.new(base_url: 'http://example.com').base_url #=> 'http://example.com'
       #
       # @example Overriding the base_url via a parameter
       #   ENV['PARLIAMENT_BASE_URL'] #=> 'http://test.com'
       #
-      #   Parliament::Request.new(base_url: 'http://example.com').base_url #=> 'http://example.com'
+      #   Parliament::Request::BaseRequest.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::BaseRequest.headers = { 'Accept' => 'Test' }
       #
-      #   Parliament::Request.new.headers #=> '{ 'Accept' => 'Test' }
+      #   Parliament::Request::BaseRequest.new.headers #=> '{ 'Accept' => 'Test' }
       #
       # @example Setting the headers via a parameter
-      #   Parliament::Request.headers #=> nil
+      #   Parliament::Request::BaseRequest.headers #=> nil
       #
-      #   Parliament::Request.new(headers: '{ 'Accept' => 'Test' }).headers #=> { 'Accept' => 'Test' }
+      #   Parliament::Request::BaseRequest.new(headers: '{ 'Accept' => 'Test' }).headers #=> { 'Accept' => 'Test' }
       #
       # @example Overriding the headers via a parameter
-      #   Parliament::Request.headers = { 'Accept' => 'Test' }
+      #   Parliament::Request::BaseRequest.headers = { 'Accept' => 'Test' }
       #
-      #   Parliament::Request.new(headers: '{ 'Accept' => 'Test2' }).headers #=> { 'Accept' => 'Test2' }
+      #   Parliament::Request::BaseRequest.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).
       # @param [Hash] headers the headers being sent in the request.
-      def initialize(base_url: nil, headers: nil, builder: nil)
+      # @param [Parliament::Builder] builder the builder to use in order to build a response.
+      # @params [Module] decorators the decorator module to use in order to provide possible alias methods for any objects created by the builder.
+      def initialize(base_url: nil, headers: nil, builder: nil, decorators: nil)
         @base_url = base_url || self.class.base_url
         @headers = headers || self.class.headers || {}
         @builder = builder || Parliament::Builder::BaseResponseBuilder
+        @decorators = decorators
       end
 
-      # Using our url built via #method_missing, make a HTTP GET request and process results into a response.
+      # Makes an HTTP GET request and process results into a response.
       #
       # @example HTTP GET request
-      #   request = Parliament::Request.new(base_url: 'http://example.com')
+      #   request = Parliament::Request::BaseRequest.new(base_url: 'http://example.com/people/123'
       #
-      #   # url: http://example.com/people/123456
-      #   response = request.people('123456').get #=> #<Parliament::Response ...>
+      #   # url: http://example.com/people/123
+      #
+      #   response = request.get #=> #<Parliament::Response::BaseResponse ...>
       #
       # @example HTTP GET request with URI encoded form values
-      #   request = Parliament::Request.new(base_url: 'http://example.com')
+      #   request = Parliament::Request.new(base_url: 'http://example.com/people/current')
       #
       #   # url: http://example.com/people/current?limit=10&page=4&lang=en-gb
-      #   response = request.people.current.get({ limit: 10, page: 4, lang: 'en-gb' }) #=> #<Parliament::Response ...>
+      #
+      #   response = request.get({ limit: 10, page: 4, lang: 'en-gb' }) #=> #<Parliament::Response::BaseResponse ...>
       #
       # @raise [Parliament::ServerError] when the server responds with a 5xx status code.
       # @raise [Parliament::ClientError] when the server responds with a 4xx status code.
-      # @raise [Parliament::NoContentResponseError] when the server responds with a 204 status code.
+      # @raise [Parliament::NoContentResponseError] when the response body is empty.
       #
       # @param [Hash] params (optional) additional URI encoded form values to be added to the URI.
       #
-      # @return [Parliament::Response] a Parliament::Response object containing all of the nodes returned from the URL.
+      # @return [Parliament::Response::BaseResponse] a Parliament::Response::BaseResponse object containing all of the data returned from the URL.
       def get(params: nil)
         endpoint_uri = URI.parse(query_url)
         endpoint_uri.query = URI.encode_www_form(params.to_a) unless params.nil?
@@ -101,7 +112,7 @@ module Parliament
       end
 
       def build_response(net_response)
-        @builder.new(net_response).build
+        @builder.new(response: net_response, decorators: @decorators).build
       end
 
       def query_url

data/lib/parliament/request/url_request.rb

@@ -1,7 +1,25 @@
 module Parliament
   module Request
+    # URL request object, allowing the user to build a URL to make a request to an API.
+    #
+    # @since 0.7.5
+    #
+    # @attr_reader [String] base_url the endpoint for our API which we will build our requests on. (expected: http://example.com - without the trailing slash).
+    # @attr_reader [Hash] headers the headers being sent in the request.
     class UrlRequest < Parliament::Request::BaseRequest
-      def initialize(base_url: nil, headers: nil, builder: nil)
+      # Creates a new instance of Parliament::Request::UrlRequest.
+      #
+      # @see Parliament::Request::BaseRequest#initialize.
+      #
+      # @param [String] base_url the base url of our api. (expected: http://example.com - without the trailing slash).
+      # @param [Hash] headers the headers being sent in the request.
+      # @param [Parliament::Builder] builder the builder to use in order to build a response.
+      # @param [Module] decorators the decorator module to use in order to provide possible alias methods for any objects created by the builder.
+      # @example Passing headers
+      #
+      # request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com', headers: { 'Access-Token' => '12345678' })
+      # This will create a request with the Access-Token set to 12345678.
+      def initialize(base_url: nil, headers: nil, builder: nil, decorators: nil)
         @endpoint_parts = []
         base_url ||= ENV['PARLIAMENT_BASE_URL']
 
@@ -11,19 +29,19 @@ module Parliament
       # Overrides ruby's method_missing to allow creation of URLs through method calls.
       #
       # @example Adding a simple URL part
-      #   request = Parliament::Request.new(base_url: 'http://example.com')
+      #   request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com')
       #
       #   # url: http://example.com/people
       #   request.people
       #
       # @example Adding a simple URL part with parameters
-      #   request = Parliament::Request.new(base_url: 'http://example.com')
+      #   request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com')
       #
       #   # url: http://example.com/people/123456
       #   request.people('123456')
       #
       # @example Chaining URL parts and using hyphens
-      #   request = Parliament::Request.new(base_url: 'http://example.com')
+      #   request = Parliament::Request::UrlRequest.new(base_url: 'http://example.com')
       #
       #   # url: http://example.com/people/123456/foo/bar/hello-world/7890
       #   request.people('123456').foo.bar('hello-world', '7890')
@@ -32,7 +50,7 @@ module Parliament
       # @param [Array<Object>] params parameters passed to the specified method (url part).
       # @param [Block] block additional block (kept for compatibility with method_missing API).
       #
-      # @return [Parliament::Request] self.
+      # @return [Parliament::Request::UrlRequest] self (this is to allow method chaining).
       def method_missing(method, *params, &block)
         @endpoint_parts << method.to_s
         @endpoint_parts << params

data/lib/parliament/response.rb

@@ -1,131 +1,7 @@
-require 'forwardable'
-
 module Parliament
-  # API response object that wraps an Array of Grom::Node objects with common helper methods.
-  #
-  # Delegates a number of common methods to the array of Grom::Nodes including, but not limited to, :size, :each, :map, :count etc.
-  #
-  # @since 0.1.0
-  #
-  # @attr_reader [Array<Grom::Node>] nodes Graph nodes.
-  class Response
-    include Enumerable
-    extend Forwardable
-    attr_reader :nodes
-    def_delegators :@nodes, :size, :each, :select, :map, :select!, :map!, :count, :length, :[], :empty?
-
-    # @param [Array<Grom::Node>] nodes An array of nodes the response should wrap
-    def initialize(nodes)
-      @nodes = nodes
-    end
-
-    # Given our array of Grom::Nodes, filter them into arrays of 'types' of nodes.
-    #
-    # Note: this method assumes all of your nodes include a #type attribute or are blank nodes.
-    #
-    # @since 0.2.0
-    #
-    # @example Filtering for a single type
-    #    node_1 = Grom::Node.new
-    #    node_1.instance_variable_set(:type, 'type_1')
-    #    node_2 = Grom::Node.new
-    #    node_2.instance_variable_set(:type, 'type_3')
-    #    node_3 = Grom::Node.new
-    #    node_3.instance_variable_set(:type, 'type_1')
-    #    node_4 = Grom::Node.new
-    #    node_4.instance_variable_set(:type, 'type_2')
-    #    nodes = [node_1, node_2, node_3, node_4]
-    #
-    #    response = Parliament::Response.new(nodes)
-    #    response.filter('type_2') #=> [#<Grom::Node @type='type_2'>]
-    #
-    # @example Filtering for multiple types
-    #    node_1 = Grom::Node.new
-    #    node_1.instance_variable_set(:type, 'type_1')
-    #    node_2 = Grom::Node.new
-    #    node_2.instance_variable_set(:type, 'type_3')
-    #    node_3 = Grom::Node.new
-    #    node_3.instance_variable_set(:type, 'type_1')
-    #    node_4 = Grom::Node.new
-    #    node_4.instance_variable_set(:type, 'type_2')
-    #    nodes = [node_1, node_2, node_3, node_4]
-    #
-    #    response = Parliament::Response.new(nodes)
-    #    response.filter('type_2', 'type_1') #=> [[#<Grom::Node @type='type_2'>], [#<Grom::Node @type='type_1'>, #<Grom::Node @type='type_1'>]]
-    #
-    #    # Also consider
-    #    type_2, type_1 = response.filter('type_2', 'type_1')
-    #    type_2 #=> [#<Grom::Node @type='type_2'>]
-    #    type_1 #=> [#<Grom::Node @type='type_1'>, #<Grom::Node @type='type_1'>]
-    #
-    # @example Filtering blank nodes
-    #    node_1 = Grom::Node.new
-    #    node_1.instance_variable_set(:type, 'type_1')
-    #    node_2 = Grom::Node.new
-    #    node_3 = Grom::Node.new
-    #    node_3.instance_variable_set(:type, 'type_1')
-    #    nodes = [node_1, node_2, node_3]
-    #
-    #    response = Parliament::Response.new(nodes)
-    #    response.filter(Grom::Node::BLANK) #=> [#<Grom::Node>]
-    #
-    # @param [Array<String>] types An array of type strings that you are looking for.
-    # @return [Array<Grom::Node> || Array<*Array<Grom::Node>>] If you pass one type, this returns an Array of Grom::Node objects. If you pass multiple, it returns an array, of arrays of Grom::Node objects.
-    def filter(*types)
-      filtered_objects = Array.new(types.size) { [] }
-
-      unless types.empty?
-        @nodes.each do |node|
-          type_index = node.blank? ? types.index(Grom::Node::BLANK) : types.index(node.type)
-
-          filtered_objects[type_index] << node unless type_index.nil?
-        end
-      end
-
-      result = build_responses(filtered_objects)
-
-      types.size == 1 ? result.first : result
-    end
-
-    # Sort the Parliament::Response nodes in ascending order by a set of attributes on each node.
-    #
-    # @see Parliament::Utils.sort_by
-    #
-    # @since 0.5.0
-    #
-    # @param [Array<Symbol>] parameters Attributes to sort on - left to right.
-    # @return [Array<Grom::Node>] A sorted array of nodes.
-    def sort_by(*parameters)
-      Parliament::Utils.sort_by({
-        list:       @nodes,
-        parameters: parameters
-      })
-    end
-
-    # Sort the Parliament::Response nodes in descending order by a set of attributes on each node.
-    #
-    # @see Parliament::Utils.reverse_sort_by
-    #
-    # @since 0.5.0
-    #
-    # @param [Array<Symbol>] parameters Attributes to sort on - left to right.
-    # @return [Array<Grom::Node>] A sorted array of nodes.
-    def reverse_sort_by(*parameters)
-      Parliament::Utils.reverse_sort_by({
-        list:       @nodes,
-        parameters: parameters
-      })
-    end
-
-    private
-
-    def build_responses(filtered_objects)
-      result = []
-
-      filtered_objects.each do |objects|
-        result << Parliament::Response.new(objects)
-      end
-      result
-    end
+  # Namespace for classes and modules that handle http responses.
+  # @since 0.7.5
+  module Response
+    require 'parliament/response/base_response'
   end
 end

data/lib/parliament/response/base_response.rb

@@ -0,0 +1,18 @@
+module Parliament
+  module Response
+    # An API response built from API data.
+    #
+    # @since 0.7.5.
+    # @attr_reader [HTTPResponse] response the HTTPResponse from the API.
+    class BaseResponse
+      attr_reader :response
+
+      # Creates a Parliament::BaseResponse object.
+      #
+      # @param [HTTPResponse] response an HTTPResponse from the API.
+      def initialize(response)
+        @response = response
+      end
+    end
+  end
+end

data/lib/parliament/version.rb

@@ -1,3 +1,3 @@
 module Parliament
-  VERSION = '0.7.4'.freeze
+  VERSION = '0.7.5.pre'.freeze
 end

data/parliament-ruby.gemspec

@@ -20,8 +20,6 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'grom', '~> 0.3.6'
-
   spec.add_development_dependency 'bundler', '~> 1.13'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
@@ -29,4 +27,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'simplecov', '~> 0.12'
   spec.add_development_dependency 'vcr', '~> 3.0'
   spec.add_development_dependency 'webmock', '~> 2.3'
+  spec.add_development_dependency 'parliament-grom-decorators'
 end

metadata

@@ -1,29 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: parliament-ruby
 version: !ruby/object:Gem::Version
-  version: 0.7.4
+  version: 0.7.5.pre
 platform: ruby
 authors:
 - Matt Rayner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-04-10 00:00:00.000000000 Z
+date: 2017-04-20 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: grom
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.6
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.3.6
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -122,6 +108,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.3'
+- !ruby/object:Gem::Dependency
+  name: parliament-grom-decorators
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Internal parliamentary data API wrapper for ruby
 email:
 - mattrayner1@gmail.com
@@ -146,31 +146,15 @@ files:
 - lib/parliament.rb
 - lib/parliament/builder.rb
 - lib/parliament/builder/base_response_builder.rb
-- lib/parliament/builder/ntriple_response_builder.rb
 - lib/parliament/client_error.rb
-- lib/parliament/decorator.rb
-- lib/parliament/decorator/constituency_area.rb
-- lib/parliament/decorator/constituency_group.rb
-- lib/parliament/decorator/contact_point.rb
-- lib/parliament/decorator/gender.rb
-- lib/parliament/decorator/gender_identity.rb
-- lib/parliament/decorator/house.rb
-- lib/parliament/decorator/house_incumbency.rb
-- lib/parliament/decorator/house_seat.rb
-- lib/parliament/decorator/incumbency.rb
-- lib/parliament/decorator/party.rb
-- lib/parliament/decorator/party_membership.rb
-- lib/parliament/decorator/person.rb
-- lib/parliament/decorator/postal_address.rb
-- lib/parliament/decorator/seat_incumbency.rb
 - lib/parliament/network_error.rb
 - lib/parliament/no_content_response_error.rb
 - lib/parliament/request.rb
 - lib/parliament/request/base_request.rb
 - lib/parliament/request/url_request.rb
 - lib/parliament/response.rb
+- lib/parliament/response/base_response.rb
 - lib/parliament/server_error.rb
-- lib/parliament/utils.rb
 - lib/parliament/version.rb
 - parliament-ruby.gemspec
 homepage: http://github.com/ukparliament/parliament_ruby
@@ -188,12 +172,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.10
+rubygems_version: 2.6.6
 signing_key: 
 specification_version: 4
 summary: Internal parliamentary API wrapper