rom-http 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 269706f2e8c14e8374fefeab550e33d7c7d58c0d
+  data.tar.gz: caa9d7aa5081a6d2fe8dc74ee5b9db0d88a905d9
+SHA512:
+  metadata.gz: aeca55f4998f9a2102add906771785036938e9f14fd463e4d3b6390497ebdec2576eefec204b22fd8722cd67f7275eff838b3328b28354b5ba9760e56584d080
+  data.tar.gz: d1bffe2ea11049e3845f6d9cd9873929bae8c9dd9d5e4bb0f95b33c07851d04b04a56bcd9a370d3447564a3f73f25a532a425e63d62aa8128b427fde096c321b

data/.gitignore

@@ -0,0 +1,16 @@
+/.bundle
+/.yardoc
+/_yardoc
+/coverage
+/vendor
+/doc
+/pkg
+/spec/reports
+/tmp
+Gemfile.lock
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+log/*.log

data/.rspec

@@ -0,0 +1,3 @@
+--require=spec_helper
+--color
+--order random

data/.rubocop.yml

@@ -0,0 +1,19 @@
+# Generated by `rubocop --auto-gen-config`
+inherit_from: .rubocop_todo.yml
+
+Metrics/LineLength:
+  Max: 100
+
+# No need to handle LoadError in Rakefile
+Lint/HandleExceptions:
+  Exclude:
+    - Rakefile
+    - rakelib/rubocop.rake
+
+# Documentation checked by Inch CI
+Style/Documentation:
+  Enabled: false
+
+# Allow rom-http
+Style/FileName:
+    Enabled: false

data/.rubocop_todo.yml

@@ -0,0 +1,6 @@
+# This configuration was generated by `rubocop --auto-gen-config`
+# on 2015-08-05 23:05:48 +0100 using RuboCop version 0.32.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.

data/.travis.yml

@@ -0,0 +1,28 @@
+language: ruby
+sudo: false
+cache: bundler
+bundler_args: --without sql benchmarks console tools
+script: "bundle exec rake ci"
+rvm:
+  - 2.0
+  - 2.1
+  - 2.2
+  - rbx-2
+  - jruby
+  - ruby-head
+  - jruby-head
+env:
+  global:
+    - JRUBY_OPTS='--dev -J-Xmx1024M'
+matrix:
+  allow_failures:
+    - rvm: ruby-head
+    - rvm: jruby-head
+    - rvm: rbx-2
+notifications:
+  webhooks:
+    urls:
+      - https://webhooks.gitter.im/e/39e1225f489f38b0bd09
+    on_success: change
+    on_failure: always
+    on_start: false

data/Gemfile

@@ -0,0 +1,21 @@
+source 'https://rubygems.org'
+
+gemspec
+
+group :test do
+  gem 'rom', github: 'rom-rb/rom', branch: 'master'
+  gem 'faraday'
+  gem 'inflecto'
+end
+
+group :tools do
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-rubocop'
+  gem 'rubocop', '~> 0.28'
+
+  platform :mri do
+    gem 'mutant', '>= 0.8.0', github: 'mbj/mutant', branch: 'master'
+    gem 'mutant-rspec'
+  end
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Ruby Object Mapper Team
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,58 @@
+# rom-http
+
+HTTP adapter for ROM
+
+### Synopsis
+
+```ruby
+require 'json'
+require 'uri'
+require 'net/http'
+
+class RequestHandler
+  def call(dataset)
+    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
+end
+
+class ResponseHandler
+  def call(response, dataset)
+    Array([JSON.parse(response.body)]).flatten
+  end
+end
+
+class Users < ROM::Relation[:http]
+  dataset :users
+
+  def by_id(id)
+    with_path(id.to_s)
+  end
+end
+
+rom = ROM::Environment.new
+rom.setup(:http, {
+  uri: 'http://jsonplaceholder.typicode.com',
+  headers: {
+    Accept: 'application/json'
+  },
+  request_handler: RequestHandler.new,
+  response_handler: ResponseHandler.new
+})
+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/Rakefile

@@ -0,0 +1,24 @@
+#!/usr/bin/env rake
+require 'bundler/gem_tasks'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), 'lib'))
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+task default: [:ci]
+
+desc 'Run CI tasks'
+task ci: [:spec]
+
+begin
+  require 'rubocop/rake_task'
+
+  Rake::Task[:default].enhance [:rubocop]
+
+  RuboCop::RakeTask.new do |task|
+    task.options << '--display-cop-names'
+  end
+rescue LoadError
+end

data/lib/rom-http.rb

@@ -0,0 +1 @@
+require 'rom/http'

data/lib/rom/http.rb

@@ -0,0 +1,8 @@
+require 'rom'
+require 'rom/http/error'
+require 'rom/http/commands'
+require 'rom/http/gateway'
+require 'rom/http/relation'
+require 'rom/http/version'
+
+ROM.register_adapter(:http, ROM::HTTP)

data/lib/rom/http/commands.rb

@@ -0,0 +1,4 @@
+require 'rom/commands'
+require 'rom/http/commands/create'
+require 'rom/http/commands/update'
+require 'rom/http/commands/delete'

data/lib/rom/http/commands/create.rb

@@ -0,0 +1,17 @@
+module ROM
+  module HTTP
+    module Commands
+      class Create < ROM::Commands::Create
+        adapter :http
+
+        def execute(tuples)
+          Array([tuples]).flatten.map do |tuple|
+            attributes = input[tuple]
+            validator.call(attributes)
+            relation.insert(attributes.to_h)
+          end.to_a
+        end
+      end
+    end
+  end
+end

data/lib/rom/http/commands/delete.rb

@@ -0,0 +1,17 @@
+module ROM
+  module HTTP
+    module Commands
+      class Delete < ROM::Commands::Delete
+        adapter :http
+
+        def execute
+          relation.delete
+        end
+
+        def assert_tuple_count
+          # noop
+        end
+      end
+    end
+  end
+end

data/lib/rom/http/commands/update.rb

@@ -0,0 +1,21 @@
+module ROM
+  module HTTP
+    module Commands
+      class Update < ROM::Commands::Update
+        adapter :http
+
+        def execute(tuples)
+          Array([tuples]).flatten.map do |tuple|
+            attributes = input[tuple]
+            validator.call(attributes)
+            relation.update(attributes.to_h)
+          end.to_a
+        end
+
+        def assert_tuple_count
+          # noop
+        end
+      end
+    end
+  end
+end

data/lib/rom/http/dataset.rb

@@ -0,0 +1,114 @@
+module ROM
+  module HTTP
+    class Dataset
+      include Enumerable
+      include Equalizer.new(:config, :options)
+
+      attr_reader :config, :options
+
+      def initialize(config, options = {})
+        @config = config
+        @options = {
+          request_method: :get,
+          path: '',
+          params: {}
+        }.merge(options)
+      end
+
+      def uri
+        config[:uri]
+      end
+
+      def headers
+        config.fetch(:headers, {}).merge(options.fetch(:headers, {}))
+      end
+
+      def name
+        config[:name].to_s
+      end
+
+      def path
+        options[:path].to_s.sub(%r{\A/}, '')
+      end
+
+      def absolute_path
+        '/' + 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))
+      end
+
+      def add_header(header, value)
+        with_headers(headers.merge(header => value))
+      end
+
+      def with_options(opts)
+        self.class.new(config, options.merge(opts))
+      end
+
+      def with_path(path)
+        with_options(path: path)
+      end
+
+      def append_path(path)
+        with_options(path: options[:path] + '/' + path)
+      end
+
+      def with_request_method(request_method)
+        with_options(request_method: request_method)
+      end
+
+      def with_params(params)
+        with_options(params: params)
+      end
+
+      def each(&block)
+        return to_enum unless block_given?
+        response.each(&block)
+      end
+
+      def insert(params)
+        with_options(
+          request_method: :post,
+          params: params
+        ).response
+      end
+
+      def update(params)
+        with_options(
+          request_method: :put,
+          params: params
+        ).response
+      end
+
+      def delete
+        with_options(
+          request_method: :delete
+        ).response
+      end
+
+      def response
+        response_handler.call(request_handler.call(self), self)
+      end
+
+      private
+
+      def response_handler
+        config[:response_handler]
+      end
+
+      def request_handler
+        config[:request_handler]
+      end
+    end
+  end
+end

data/lib/rom/http/error.rb

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,31 @@
+require 'thread_safe'
+require 'rom/http/dataset'
+
+module ROM
+  module HTTP
+    class Gateway < ROM::Gateway
+      attr_reader :datasets, :config
+      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
+
+      def [](name)
+        datasets.fetch(name)
+      end
+
+      def dataset(name)
+        datasets[name] = Dataset.new(config.merge(name: name))
+      end
+
+      def dataset?(name)
+        datasets.key?(name)
+      end
+    end
+  end
+end