rom-http 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c7d3ff1f6d9c603d8c87aab168b3ed4cc14cf0e6
-  data.tar.gz: ba29c82d3e73f6055431e1d22c00eec803e41af0
+  metadata.gz: 0a5d2946beb3f147e7b8e09a390d1db24006b131
+  data.tar.gz: 3780c786affbb10b47987b63a7344e6765ab4964
 SHA512:
-  metadata.gz: d4e0eafcd6cd8061f8c8c356b6e4deed06aa03f16ec98cc17e1c686a0f385c354971410728e9093114e4ed020202bcfdc61b2db001ce214aa2bd2868ae6a0086
-  data.tar.gz: 1480059baaaa7390b255eb2a7c057a4073ac4eb71c76444eceaaa89cac905ca54913d6010d8f24c6bf94fe0300a8e2f312d2c4e0fe51baee86b1fc57f36323b2
+  metadata.gz: 1d12b8a1740657967ed774d8bfd61af0f738123ca92e857a7eeb5a82deb53c4c1defeca7229216e636abbb3f3c3f4ce51de211b2dd9bc2822f41f597ec2f6f5f
+  data.tar.gz: 2b39120ff86cf082e57395c2b188b40acd72e746d5d26a567b4d89bad4e7cb8dacd518889450d208b7342956ce378ffb0519af828f60bf2236e115f612523cc7

data/.rubocop.yml

@@ -4,6 +4,9 @@ inherit_from: .rubocop_todo.yml
 Metrics/LineLength:
   Max: 100
 
+Style/CaseEquality:
+  Enabled: false
+
 # No need to handle LoadError in Rakefile
 Lint/HandleExceptions:
   Exclude:

data/.rubocop_todo.yml

@@ -1,6 +1,12 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-08-05 23:05:48 +0100 using RuboCop version 0.32.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2015-09-03 20:59:57 +0100 using RuboCop version 0.33.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
+
+# Offense count: 1
+# Configuration parameters: CountComments.
+Metrics/ClassLength:
+  Max: 104

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.1.1 2015-09-03
+### Added
+
+  - `ROM::HTTP::Dataset` macros for setting `default_request_handler` and `default_response_handler` (AMHOL)
+
+### Changed
+
+- `ROM::HTTP::Gateway` tries to load the `Dataset` class lazily from the same namespace that the `Gateway` is defined in, with a fallback to `ROM::HTTP::Dataset`, making extending easier (AMHOL)
+- `ROM::HTTP::Gateway` no longer raises errors on missing configuration keys, these are now raised late in `Dataset` - this was to allow for the implementation of `default_request_handler` and `default_response_handler` (AMHOL)
+- `ROM::HTTP::Dataset` now uses `ROM::Options` from `rom-support`, adding typechecking to options and making it easier to define additional options in extensions
+
+[Compare v0.1.0...v0.1.1](https://github.com/rom-rb/rom-http/compare/v0.1.0...v0.1.1)
+
 # v0.1.0 2015-08-19
 
 First public release \o/

data/README.md

@@ -62,3 +62,81 @@ container = rom.finalize.env
 container.relation(:users).by_id(1).to_a
 # => GET http://jsonplaceholder.typicode.com/users/1 [ Accept: application/json ]
 ```
+
+### Extending
+
+```ruby
+require 'json'
+require 'uri'
+require 'net/http'
+
+module ROM
+  module MyAdapter
+    class Dataset < ROM::HTTP::Dataset
+      default_request_handler ->(dataset) do
+        uri = URI(dataset.uri)
+        uri.path = "/#{dataset.name}/#{dataset.path}"
+        uri.query = URI.encode_www_form(dataset.params)
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        request_klass = Net::HTTP.const_get(ROM::Inflector.classify(dataset.request_method))
+
+        request = request_klass.new(uri.request_uri)
+        dataset.headers.each_with_object(request) do |(header, value), request|
+          request[header.to_s] = value
+        end
+
+        response = http.request(request)
+      end
+
+      default_response_handler ->(response, dataset) do
+        Array([JSON.parse(response.body)]).flatten
+      end
+    end
+
+    class Gateway < ROM::HTTP::Gateway; end
+
+    class Relation < ROM::HTTP::Relation
+      adapter :my_adapter
+    end
+
+    module Commands
+      class Create < ROM::HTTP::Commands::Create
+        adapter :my_adapter
+      end
+
+      class Update < ROM::HTTP::Commands::Create
+        adapter :my_adapter
+      end
+
+      class Delete < ROM::HTTP::Commands::Create
+        adapter :my_adapter
+      end
+    end
+  end
+end
+
+ROM.register_adapter(:my_adapter, ROM::MyAdapter)
+
+rom = ROM::Environment.new
+rom.setup(:my_adapter, {
+  uri: 'http://jsonplaceholder.typicode.com',
+  headers: {
+    Accept: 'application/json'
+  }
+})
+
+class Users < ROM::Relation[:my_adapter]
+  dataset :users
+
+  def by_id(id)
+    with_path(id.to_s)
+  end
+end
+
+rom.register_relation(Users)
+
+container = rom.finalize.env
+container.relation(:users).by_id(1).to_a
+# => GET http://jsonplaceholder.typicode.com/users/1 [ Accept: application/json ]
+```

data/lib/rom/http/dataset.rb

@@ -3,20 +3,34 @@ module ROM
     class Dataset
       include Enumerable
       include Equalizer.new(:config, :options)
+      include ROM::Options
 
-      attr_reader :config, :options
+      attr_reader :config
+
+      option :request_method, type: ::Symbol, default: :get, reader: true
+      option :path, type: ::String, default: ''
+      option :params, type: ::Hash, default: {}, reader: true
+      option :headers, type: ::Hash, default: {}
+
+      class << self
+        def default_request_handler(handler = Undefined)
+          return @default_request_handler if Undefined === handler
+          @default_request_handler = handler
+        end
+
+        def default_response_handler(handler = Undefined)
+          return @default_response_handler if Undefined === handler
+          @default_response_handler = handler
+        end
+      end
 
       def initialize(config, options = {})
         @config = config
-        @options = {
-          request_method: :get,
-          path: '',
-          params: {}
-        }.merge(options)
+        super(options)
       end
 
       def uri
-        config[:uri]
+        config.fetch(:uri) { fail Error, ':uri configuration missing' }
       end
 
       def headers
@@ -35,16 +49,8 @@ module ROM
         '/' + path
       end
 
-      def request_method
-        options[:request_method]
-      end
-
-      def params
-        options[:params]
-      end
-
       def with_headers(headers)
-        self.class.new(config, options.merge(headers: headers))
+        __new__(config, options.merge(headers: headers))
       end
 
       def add_header(header, value)
@@ -52,7 +58,7 @@ module ROM
       end
 
       def with_options(opts)
-        self.class.new(config, options.merge(opts))
+        __new__(config, options.merge(opts))
       end
 
       def with_path(path)
@@ -103,11 +109,27 @@ module ROM
       private
 
       def response_handler
-        config[:response_handler]
+        config.fetch(:response_handler, default_response_handler).tap do |response_handler|
+          fail Error, ':response_handler configuration missing' if response_handler.nil?
+        end
       end
 
       def request_handler
-        config[:request_handler]
+        config.fetch(:request_handler, default_request_handler).tap do |request_handler|
+          fail Error, ':response_handler configuration missing' if request_handler.nil?
+        end
+      end
+
+      def default_response_handler
+        self.class.default_response_handler
+      end
+
+      def default_request_handler
+        self.class.default_request_handler
+      end
+
+      def __new__(*args, &block)
+        self.class.new(*args, &block)
       end
     end
   end

data/lib/rom/http/error.rb

@@ -1,17 +1,5 @@
 module ROM
   module HTTP
     Error = Class.new(StandardError)
-
-    class GatewayConfigurationError < Error
-      def initialize(missing_keys)
-        if missing_keys.length > 1
-          msg = "Missing #{missing_keys[0..-1].join(', ')} and #{missing_keys.last}"
-        else
-          msg = "Missing #{missing_keys.last}"
-        end
-
-        super(msg + ' in ROM::HTTP::Gateway configuration')
-      end
-    end
   end
 end

data/lib/rom/http/gateway.rb

@@ -8,9 +8,6 @@ module ROM
       private :datasets, :config
 
       def initialize(config)
-        missing_keys = [:uri, :request_handler, :response_handler] - config.keys
-        fail GatewayConfigurationError, missing_keys unless missing_keys.empty?
-
         @datasets = ThreadSafe::Cache.new
         @config = config
       end
@@ -20,12 +17,21 @@ module ROM
       end
 
       def dataset(name)
-        datasets[name] = Dataset.new(config.merge(name: name))
+        dataset_klass = namespace.const_defined?(:Dataset) ? namespace.const_get(:Dataset) : Dataset
+        datasets[name] = dataset_klass.new(config.merge(name: name))
       end
 
       def dataset?(name)
         datasets.key?(name)
       end
+
+      private
+
+      def namespace
+        self.class.to_s[/(.*)(?=::)/].split('::').inject(::Object) do |constant, const_name|
+          constant.const_get(const_name)
+        end
+      end
     end
   end
 end

data/lib/rom/http/version.rb

@@ -1,5 +1,5 @@
 module ROM
   module HTTP
-    VERSION = '0.1.0'.freeze
+    VERSION = '0.1.1'.freeze
   end
 end

data/spec/shared/command_behaviour.rb

@@ -1,10 +1,10 @@
 shared_examples_for 'a command' do
   describe '#method_missing' do
     it 'forwards to relation and wraps response if it returned another relation' do
-      new_command = command.with_params(1)
+      new_command = command.with_params({})
 
       expect(new_command).to be_instance_of(command.class)
-      expect(new_command.relation).to eq(command.with_params(1).relation)
+      expect(new_command.relation).to eq(command.with_params({}).relation)
     end
 
     it 'returns original response if it was not a relation' do

data/spec/unit/rom/http/dataset_spec.rb

@@ -1,5 +1,6 @@
 RSpec.describe ROM::HTTP::Dataset do
-  let(:dataset) { ROM::HTTP::Dataset.new(config, options) }
+  let(:klass) { ROM::HTTP::Dataset }
+  let(:dataset) { klass.new(config, options) }
   let(:config) do
     {
       uri: uri,
@@ -51,33 +52,74 @@ RSpec.describe ROM::HTTP::Dataset do
           is_expected.to eq(
             request_method: :get,
             path: '',
-            params: {}
+            params: {},
+            headers: {}
           )
         end
       end
     end
   end
 
-  describe '#==' do
-    subject { dataset == other }
+  describe '.default_request_handler' do
+    before do
+      module Test
+        class Dataset < ROM::HTTP::Dataset; end
+      end
+    end
+
+    context 'when no default_request_handler set' do
+      it 'returns nil' do
+        expect(klass.default_request_handler).to be nil
+      end
+    end
+
+    context 'when default_request_handler set' do
+      before do
+        Test::Dataset.default_request_handler(request_handler)
+      end
+
+      it 'returns the default request handler' do
+        expect(Test::Dataset.default_request_handler).to eq request_handler
+      end
+    end
+  end
 
-    context 'with config and options equal' do
-      let(:other) { ROM::HTTP::Dataset.new(dataset.config, dataset.options) }
+  describe '.default_response_handler' do
+    before do
+      module Test
+        class Dataset < ROM::HTTP::Dataset; end
+      end
+    end
 
-      it { is_expected.to be true }
+    context 'when no default_response_handler set' do
+      it 'returns nil' do
+        expect(klass.default_response_handler).to be nil
+      end
     end
 
-    context 'with config and options equal' do
-      let(:other) do
-        ROM::HTTP::Dataset.new(dataset.config, dataset.options.merge(path: Random.new_seed))
+    context 'when default_response_handler set' do
+      before do
+        Test::Dataset.default_response_handler(response_handler)
       end
 
-      it { is_expected.to be false }
+      it 'returns the default response handler' do
+        expect(Test::Dataset.default_response_handler).to eq response_handler
+      end
     end
   end
 
   describe '#uri' do
-    it { expect(dataset.uri).to eq(uri) }
+    context 'when no uri configured' do
+      let(:config) { {} }
+
+      it do
+        expect { dataset.uri }.to raise_error(ROM::HTTP::Error)
+      end
+    end
+
+    context 'when uri configured' do
+      it { expect(dataset.uri).to eq(uri) }
+    end
   end
 
   describe '#headers' do
@@ -288,7 +330,8 @@ RSpec.describe ROM::HTTP::Dataset do
         path: '',
         params: {
           name: name
-        }
+        },
+        headers: {}
       )
     end
     it { is_expected.to_not be(dataset) }
@@ -458,15 +501,56 @@ RSpec.describe ROM::HTTP::Dataset do
     let(:response) { double }
     let(:result) { double }
 
-    before do
-      allow(request_handler).to receive(:call).and_return(response)
-      allow(response_handler).to receive(:call).and_return(result)
+    context 'when request_handler and response_handler configured' do
+      before do
+        allow(request_handler).to receive(:call).and_return(response)
+        allow(response_handler).to receive(:call).and_return(result)
+      end
+
+      subject! { dataset.response }
+
+      it { expect(request_handler).to have_received(:call).with(dataset) }
+      it { expect(response_handler).to have_received(:call).with(response, dataset) }
+      it { is_expected.to eq(result) }
     end
 
-    subject! { dataset.response }
+    context 'when request_handler and response_handler configured' do
+      let(:klass) { Test::Dataset }
+      let(:config) { {} }
+
+      before do
+        module Test
+          class Dataset < ROM::HTTP::Dataset; end
+        end
+
+        Test::Dataset.default_request_handler(request_handler)
+        Test::Dataset.default_response_handler(response_handler)
+
+        allow(request_handler).to receive(:call).and_return(response)
+        allow(response_handler).to receive(:call).and_return(result)
+      end
+
+      subject! { dataset.response }
 
-    it { expect(request_handler).to have_received(:call).with(dataset) }
-    it { expect(response_handler).to have_received(:call).with(response, dataset) }
-    it { is_expected.to eq(result) }
+      it { expect(request_handler).to have_received(:call).with(dataset) }
+      it { expect(response_handler).to have_received(:call).with(response, dataset) }
+      it { is_expected.to eq(result) }
+    end
+
+    context 'when no request_handler configured and no default set' do
+      let(:config) { { response_handler: response_handler } }
+
+      it do
+        expect { dataset.response }.to raise_error(ROM::HTTP::Error)
+      end
+    end
+
+    context 'when no response_handler configured and no default set' do
+      let(:config) { { request_handler: request_handler } }
+
+      it do
+        expect { dataset.response }.to raise_error(ROM::HTTP::Error)
+      end
+    end
   end
 end

data/spec/unit/rom/http/gateway_spec.rb

@@ -29,9 +29,43 @@ RSpec.describe ROM::HTTP::Gateway do
     end
   end
 
-  describe 'required config' do
-    it 'errors if config does not meet requirements' do
-      expect { ROM::HTTP::Gateway.new({}) }.to raise_error(ROM::HTTP::GatewayConfigurationError)
+  describe '#dataset' do
+    subject { gateway.dataset(:name) }
+
+    context 'when extended' do
+      let(:gateway) { Test::Gateway.new({}) }
+
+      before do
+        module Test
+          class Gateway < ROM::HTTP::Gateway; end
+        end
+      end
+
+      context 'when no Dataset defined in the same namespace' do
+        it 'returns ROM::HTTP::Dataset' do
+          is_expected.to be_kind_of(ROM::HTTP::Dataset)
+        end
+      end
+
+      context 'when Dataset defined in the same namespace' do
+        before do
+          module Test
+            class Dataset < ROM::HTTP::Dataset; end
+          end
+        end
+
+        it 'returns ROM::HTTP::Dataset' do
+          is_expected.to be_kind_of(Test::Dataset)
+        end
+      end
+    end
+
+    context 'when not extended' do
+      let(:gateway) { ROM::HTTP::Gateway.new({}) }
+
+      it 'returns ROM::HTTP::Dataset' do
+        is_expected.to be_kind_of(ROM::HTTP::Dataset)
+      end
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rom-http
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Piotr Solnica
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-19 00:00:00.000000000 Z
+date: 2015-09-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rom
@@ -172,7 +172,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: HTTP support for ROM