grom_native 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ebd48a48877c286e945be1794ab5e3a59ea3086fd85f04375fd8365d0b2228d4
-  data.tar.gz: 12a425fc546997201664f94a1534d580645edb14b3ff4cb963adab7f6a21df14
+  metadata.gz: 856f8f1624b22099e215a07e69dcd9c1ecba8c39e5641ae2e39b956eb6455e99
+  data.tar.gz: 2080714e05709281f6a1c90bb88d5b52cdaa2d1085de56cbb8e57fd96aa03382
 SHA512:
-  metadata.gz: 1bc8c5d19da2237ff4b4f297749c3c603cb1b90edf0eb7efc1b8c9573ad12d12d2cf10c04e87a6bee8d258b48bdea3be7150fd112a078880268fb14c87127ab3
-  data.tar.gz: b9cfb3b2acb7773d509eac22c8cd60d7bce12a13f8368677c273839b8f3cfb1254d63ee2578f302296023c77d33ba767a0575dbb3a05dc76a33105fd45dc816b
+  metadata.gz: 0b9ee1c0bca7ed33166e1caf31b75e45a02e74881cc79149869262d95faca10c16363b81b39e6292b329e119d8f9996a2ce4052e08f6024666900c1274bd191f
+  data.tar.gz: b04c55804680f20ddf33a780f266d60894c574fc8055d077a8daaa2b15cd1daf42eb3f37ad4cadb62a43faba6af5bbaede1b572e84025e26d3b8d19cb6d54190

data/Gemfile.lock

@@ -1,10 +1,9 @@
 PATH
   remote: .
   specs:
-    grom_native (0.1.0)
+    grom_native (0.1.1)
       ffi (~> 1.9)
       grom
-      parliament-grom-decorators
       rdf (~> 3.0)
 
 GEM
@@ -70,6 +69,7 @@ PLATFORMS
 DEPENDENCIES
   bundler (~> 1.16)
   grom_native!
+  parliament-grom-decorators
   rack (~> 2.0)
   rake (~> 10.0)
   rspec (~> 3.0)

data/{GromNative.gemspec → gromnative.gemspec}

@@ -10,7 +10,7 @@ Gem::Specification.new do |spec|
   spec.email         = ['m@rayner.io']
 
   spec.summary       = %q{A GROM implementation using a GO native extension for heavy lifting.}
-  spec.homepage      = 'https://github.com/mattrayner/nativegrom'
+  spec.homepage      = 'https://github.com/ukparliament/gromnative'
   spec.license       = 'MIT'
 
   # Specify which files should be added to the gem when it is released.
@@ -25,9 +25,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'ffi', '~> 1.9'
   spec.add_dependency 'grom'
   spec.add_dependency 'rdf', '~> 3.0'
-  spec.add_dependency 'parliament-grom-decorators'
 
   spec.add_development_dependency 'bundler', '~> 1.16'
+  spec.add_development_dependency 'parliament-grom-decorators'
   spec.add_development_dependency 'rack', '~> 2.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'

data/lib/grom_native/request.rb

@@ -0,0 +1,144 @@
+module GromNative
+    # 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
+      # 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']
+        @headers        = headers || self.class.headers || {}
+        @builder        = builder || Parliament::Builder::BaseResponseBuilder
+        @decorators     = decorators
+        @query_params   = {}
+      end
+
+      # Makes an HTTP GET request and process results into a response.
+      #
+      # @example HTTP GET request
+      #   request = Parliament::Request::BaseRequest.new(base_url: 'http://example.com/people/123'
+      #
+      #   # 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/people/current')
+      #
+      #   # url: http://example.com/people/current?limit=10&page=4&lang=en-gb
+      #
+      #   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 response body is empty.
+      #
+      # @param [Hash] params (optional) additional URI encoded form values to be added to the URI.
+      #
+      # @return [Parliament::Response::BaseResponse] a Parliament::Response::BaseResponse object containing all of the data returned from the URL.
+      def get(params: {}, filter: [])
+        uri = URI.parse(query_url)
+
+        temp_params = {}
+
+        if uri.query
+          # Returns [ ["key", "value"], ["key", "value"] ]
+          key_value_array = URI.decode_www_form(endpoint.query)
+          key_value_array.map! { |key_value_pair| [ key_value_pair[0].to_sym, key_value_pair[1] ] }
+          temp_params = key_value_array.to_h
+        end
+
+        temp_params = temp_params.merge(params)
+
+        uri.query = temp_params
+
+        GromNative.fetch( uri: uri.to_s, headers: headers, filter: filter, decorators: @decorators )
+      end
+
+      # Overrides ruby's method_missing to allow creation of URLs through method calls.
+      #
+      # @example Adding a simple URL part
+      #   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::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::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')
+      #
+      # @param [Symbol] method the 'method' (url part) we are processing.
+      # @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::UrlRequest] self (this is to allow method chaining).
+      def method_missing(method, *params, &block)
+        @endpoint_parts << method.to_s
+
+        @endpoint_parts << params
+        @endpoint_parts = @endpoint_parts.flatten!
+
+        block&.call
+
+        self || super
+      end
+
+      # This class always responds to method calls, even those missing. Therefore, respond_to_missing? always returns true.
+      #
+      # @return [Boolean] always returns true.
+      def respond_to_missing?(_, _ = false)
+        true # responds to everything, always
+      end
+
+      def query_url
+        uri_string = [@base_url, @endpoint_parts].join('/').gsub(' ', '%20')
+
+        uri = URI.parse(uri_string)
+        uri.query = URI.encode_www_form(@query_params) unless @query_params.empty?
+
+        uri.to_s
+      end
+
+      # @return [Parliament::Request::UrlRequest] self (this is to allow method chaining).
+      def set_url_params(params)
+        @query_params = @query_params.merge(params)
+
+        self
+      end
+
+      def default_headers
+        { 'Accept' => ['*/*', 'application/n-triples'] }
+      end
+
+      def headers
+        default_headers.merge(@headers)
+      end
+
+      class << self
+        attr_accessor :base_url, :headers
+      end
+    end
+  end
+end

data/lib/grom_native/version.rb

@@ -1,3 +1,3 @@
 module GromNative
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: grom_native
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matt Rayner
@@ -53,33 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: parliament-grom-decorators
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.16'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.16'
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: parliament-grom-decorators
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rack
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +143,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".DS_Store"
 - ".gitignore"
 - ".rspec"
 - ".ruby-version"
@@ -152,7 +153,6 @@ files:
 - Gemfile.lock
 - Gopkg.lock
 - Gopkg.toml
-- GromNative.gemspec
 - LICENSE.txt
 - Makefile
 - README.md
@@ -169,10 +169,12 @@ files:
 - ext/processor/spec/processor_suite_test.go
 - ext/types/net.proto
 - ext/types/net/net.pb.go
+- gromnative.gemspec
 - lib/grom_native.rb
 - lib/grom_native/node.rb
+- lib/grom_native/request.rb
 - lib/grom_native/version.rb
-homepage: https://github.com/mattrayner/nativegrom
+homepage: https://github.com/ukparliament/gromnative
 licenses:
 - MIT
 metadata: {}