rom-http 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5fd07f83166373c0e0f2bfe8c83f8f68578818dc
-  data.tar.gz: e643299868045661adadfd6ea6881cf59feda4fe
+SHA256:
+  metadata.gz: d88086baa2e0dccb6c7917f2e0a5ccf3ec268fa722f1648283b66ea9feb839e2
+  data.tar.gz: 3c4385179232ad49adc12214a00ecd690663828eaf1defb05d7af042a3e85d8e
 SHA512:
-  metadata.gz: 2a2de5a39a3cf600c2464250809a2e292c7abef3a8e1b2e79232ac035b14992a160a56035c5c7a65414ab60b643093ac375e234ffab952c6a262f3517cd146fd
-  data.tar.gz: 44315f4744aa86c60fb92c801bd1521e2834dbada29fd53a6cfc4a6f35f27fb09cb335719d9bb4b52be5f1bda9c549539f4e98c96fca2344640c2e7b0a096062
+  metadata.gz: 2a9ff4446983f2b2a996e8ea488b2f8212a16aaaeac1165244169c6d914df3bb8decdc8eb7ecef4c5afec98c0f29162d923dd288146770de8f10b4ff5335ba32
+  data.tar.gz: e0078237b342b0578adad5a8741fa80ad2798d9d5038d30eb4eef329e440486e028f98084ffac936948e1bb94d27552c81ecca56a83b98ec67980598e8a2761f

data/CHANGELOG.md

@@ -1,3 +1,29 @@
+# v0.8.0 2019-04-29
+
+This is a major overhaul of the gem which brings it closer to 1.0.0. Custom data mapping was replaced by core APIs that leverage schemas and their attributes. Custom `MapperCompiler` was added that rejects keys that are not specified in the schemas, and can be extended further to meet any future requirements.
+
+As a consequence of these changes, with this release you can easily use `rom-http` along with repositories and changesets.
+
+### Added
+
+- Support for relation schemas (solnic)
+- Support for auto-struct mapping (solnic)
+- Support for registering your own request/response handlers for all datasets from a specific gateway (solnic)
+- Built-in `JSON` handlers that you can set via `handlers: :json` gateway option (solnic)
+- Convenient request method predicates `Dataset#{get?,post?,delete?,put?}` (solnic)
+
+### Changed
+
+- Updated to work with `rom ~> 5.0` (parndt)
+- Input/output data are now handled by core functionality using schema's `input_schema` and `output_schema` (solnic)
+- `Dataset#name` was removed in favor of `Dataset#base_path`
+
+### Fixed
+
+- `Relation#append_path` no longer duplicates `base_path` (solnic)
+
+[Compare v0.7.0...v0.8.0](https://github.com/rom-rb/rom-http/compare/v0.7.0...v0.8.0)
+
 # v0.7.0 2018-01-11
 
 ### Added
@@ -9,8 +35,6 @@
   - Removed ruby 2.1 support (maximderbin)
   - Removed rbx-3 support (maximderbin)
 
-
-
 [Compare v0.5.0...v0.6.0](https://github.com/rom-rb/rom-http/compare/v0.6.0...v0.7.0)
 
 # v0.6.0 2017-02-06

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2015 Ruby Object Mapper Team
+Copyright (c) 2015-2019 rom-rb team
 
 MIT License
 

data/README.md

@@ -1,21 +1,23 @@
 [gem]: https://rubygems.org/gems/rom-http
 [travis]: https://travis-ci.org/rom-rb/rom-http
-[gemnasium]: https://gemnasium.com/rom-rb/rom-http
 [codeclimate]: https://codeclimate.com/github/rom-rb/rom-http
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-http
-[gitter]: https://gitter.im/rom-rb/chat
-[rom]:  https://github.com/rom-rb/rom
+[chat]: https://rom-rb.zulipchat.com
 
-
-# rom-http [![Gitter chat](https://badges.gitter.im/rom-rb/chat.svg)][gitter]
+# rom-http [![Join the chat at https://rom-rb.zulipchat.com](https://img.shields.io/badge/rom--rb-join%20chat-942283.svg)][chat]
 
 [![Gem Version](https://badge.fury.io/rb/rom-http.svg)][gem]
 [![Build Status](https://travis-ci.org/rom-rb/rom-http.svg?branch=master)][travis]
-[![Dependency Status](https://gemnasium.com/rom-rb/rom-http.svg)][gemnasium]
 [![Code Climate](https://codeclimate.com/github/rom-rb/rom-http/badges/gpa.svg)][codeclimate]
-[![Documentation Status](http://inch-ci.org/github/rom-rb/rom-http.svg?branch=master&style=flat)][inchpages]
+[![Test Coverage](https://codeclimate.com/github/rom-rb/rom-http/badges/coverage.svg)][codeclimate]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-http.svg?branch=master)][inchpages]
+
+HTTP adapter for [rom-rb](https://github.com/rom-rb/rom).
+
+Resources:
 
-HTTP adapter for [Ruby Object Mapper][rom]
+- [User Documentation](http://rom-rb.org/learn/http/)
+- [API Documentation](http://rubydoc.info/gems/rom-http)
 
 ## Installation
 
@@ -33,11 +35,6 @@ Or install it yourself as:
 
     $ gem install rom-http
 
-## ROADMAP
-
-For details please refer to [issues](https://github.com/rom-rb/rom-http/issues).
-
-
 ## License
 
 See `LICENSE` file.
@@ -77,7 +74,7 @@ end
 
 class Users < ROM::Relation[:http]
   schema(:users) do
-    attribute :id, ROM::Types::Int
+    attribute :id, ROM::Types::Integer
     attribute :name, ROM::Types::String
     attribute :username, ROM::Types::String
     attribute :email, ROM::Types::String
@@ -174,7 +171,7 @@ configuration = ROM::Configuration.new(:my_adapter, {
 
 class Users < ROM::Relation[:my_adapter]
   schema(:users) do
-    attribute :id, ROM::Types::Int
+    attribute :id, ROM::Types::Integer
     attribute :name, ROM::Types::String
     attribute :username, ROM::Types::String
     attribute :email, ROM::Types::String

data/lib/rom-http.rb

@@ -1 +1,3 @@
+# frozen_string_literal: true
+
 require 'rom/http'

data/lib/rom/http.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom'
 require 'rom/http/error'
 require 'rom/http/commands'

data/lib/rom/http/attribute.rb

@@ -0,0 +1,10 @@
+# frozen_string_literal: true
+
+require 'rom/attribute'
+
+module ROM
+  module HTTP
+    class Attribute < ROM::Attribute
+    end
+  end
+end

data/lib/rom/http/commands.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rom/commands'
 require 'rom/http/commands/create'
 require 'rom/http/commands/update'

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module HTTP
     module Commands

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module HTTP
     module Commands

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module ROM
   module HTTP
     module Commands

data/lib/rom/http/dataset.rb

@@ -1,114 +1,194 @@
+# frozen_string_literal: true
+
 require 'uri'
-require 'dry-configurable'
+
+require 'dry/configurable'
 require 'dry/core/deprecations'
+
+require 'rom/support/memoizable'
+require 'rom/constants'
 require 'rom/initializer'
-require 'rom/http/dataset/class_interface'
+require 'rom/http/types'
+require 'rom/http/transformer'
 
 module ROM
   module HTTP
     # HTTP Dataset
     #
-    # Represents a specific HTTP collection resource
+    # Represents a specific HTTP collection resource. This class can be
+    # subclassed in a specialized HTTP adapter to provide its own
+    # response/request handlers or any other configuration that should
+    # differ from the defaults.
     #
     # @api public
     class Dataset
       PATH_SEPARATOR = '/'.freeze
 
-      extend ::ROM::Initializer
-      extend ::Dry::Configurable
-      extend ::ROM::HTTP::Dataset::ClassInterface
-      include ::Enumerable
-      include ::Dry::Equalizer(:config, :options)
-
-      setting :default_request_handler
-      setting :default_response_handler
-      setting :param_encoder, ->(params) { URI.encode_www_form(params) }
-
-      param :config
-
-      option :request_method, type: Types::Symbol, default: proc { :get }, reader: true
-      option :base_path, type: Types::String, default: proc { name }
-      option :path, type: Types::String, default: proc { '' }, reader: false
-      option :params, type: Types::Hash, default: proc { {} }, reader: true
-      option :headers, type: Types::Hash, default: proc { {} }
-
-      # Return the gateway's URI
-      #
-      # @return [String]
-      #
-      # @raise [Error] if the configuration does not contain a URI
+      extend Dry::Configurable
+      extend ROM::Initializer
+
+      include ROM::Memoizable
+      include Enumerable
+      include Dry::Equalizer(:options)
+
+      # @!method self.default_request_handler
+      #   Return configured default request handler
+      #
+      #   @example
+      #     class MyDataset < ROM::HTTP::Dataset
+      #       configure do |config|
+      #         config.default_request_handler = MyRequestHandler
+      #       end
+      #     end
+      #
+      #     MyDataset.default_request_handler # MyRequestHandler
+      #     MyDataset.new(uri: "http://localhost").request_handler # MyRequestHandler
+      setting :default_request_handler, reader: true
+
+      # @!method self.default_response_handler
+      #   Return configured default response handler
+      #
+      #   @example
+      #     class MyDataset < ROM::HTTP::Dataset
+      #       configure do |config|
+      #         config.default_response_handler = MyResponseHandler
+      #       end
+      #     end
+      #
+      #     MyDataset.default_response_handler # MyResponseHandler
+      #     MyDataset.new(uri: "http://localhost").response_handler # MyResponseHandler
+      setting :default_response_handler, reader: true
+
+      # @!method self.param_encoder
+      #   Return configured param encoder
+      #
+      #   @example
+      #     class MyDataset < ROM::HTTP::Dataset
+      #       configure do |config|
+      #         config.param_encoder = MyParamEncoder
+      #       end
+      #     end
+      #
+      #     MyDataset.param_encoder # MyParamEncoder
+      #     MyDataset.new(uri: "http://localhost").param_encoder # MyParamEncoder
+      setting :param_encoder, URI.method(:encode_www_form), reader: true
+
+      # @!attribute [r] request_handler
+      #   @return [Object]
+      #   @api public
+      option :request_handler, default: proc { self.class.default_request_handler }
+
+      # @!attribute [r] response_handler
+      #   @return [Object]
+      #   @api public
+      option :response_handler, default: proc { self.class.default_response_handler }
+
+      # @!attribute [r] request_method
+      #   @return [Symbol]
+      #   @api public
+      option :request_method, type: Types::Symbol, default: proc { :get }
+
+      # @!attribute [r] base_path
+      #   @return [String]
+      #   @api public
+      option :base_path, type: Types::Path, default: proc { EMPTY_STRING }
+
+      # @!attribute [r] path
+      #   @return [String]
+      #   @api public
+      option :path, type: Types::Path, default: proc { EMPTY_STRING }
+
+      # @!attribute [r] params
+      #   @return [Hash]
+      #   @api public
+      option :params, type: Types::Hash, default: proc { EMPTY_HASH }
+
+      # @!attribute [r] headers
+      #   @return [Hash]
+      #   @api public
+      option :headers, type: Types::Hash, default: proc { EMPTY_HASH }
+
+      # @!attribute [r] headers
+      #   @return [Hash]
+      #   @api public
+      option :param_encoder, default: proc { self.class.param_encoder }
+
+      # @!attribute [r] uri
+      #   @return [String]
+      #   @api public
+      option :uri, type: Types::String
+
+      # Return the dataset's URI
+      #
+      # @return [URI::HTTP]
       #
       # @api public
       def uri
-        uri = config.fetch(:uri) { fail Error, '+uri+ configuration missing' }
-        uri = URI(join_path(uri, path))
-        if request_method == :get && params.any?
-          uri.query = self.class.config.param_encoder.call(params)
+        uri = URI(join_path(super, path))
+
+        if get? && params.any?
+          uri.query = param_encoder.call(params)
         end
 
         uri
       end
 
-      # Return request headers
+      # Return true if request method is set to :get
       #
-      # Merges default headers from the Gateway configuration and the
-      # current Dataset
+      # @return [Boolean]
       #
-      # @example
-      #   config = { Accepts: 'application/json' }
-      #   users  = Dataset.new(config, headers: { 'Cache-Control': 'no-cache' }
-      #   users.headers
-      #   # => {:Accepts => "application/json", :'Cache-Control' => 'no-cache'}
+      # @api public
+      def get?
+        request_method.equal?(:get)
+      end
+
+      # Return true if request method is set to :post
       #
-      # @return [Hash]
+      # @return [Boolean]
       #
       # @api public
-      def headers
-        config.fetch(:headers, {}).merge(options.fetch(:headers, {}))
+      def post?
+        request_method.equal?(:post)
       end
 
-      # Return the dataset name
+      # Return true if request method is set to :put
       #
-      # @return [String]
+      # @return [Boolean]
       #
       # @api public
-      def name
-        config[:name].to_s
+      def put?
+        request_method.equal?(:put)
       end
 
-      # Return the base path
-      #
-      # @example
-      #   Dataset.new(config, base_path: '/users').base_path
-      #   # => 'users'
+      # Return true if request method is set to :delete
       #
-      # @return [String] the dataset path, without a leading slash
+      # @return [Boolean]
       #
       # @api public
-      def base_path
-        strip_path(super)
+      def delete?
+        request_method.equal?(:delete)
       end
 
       # Return the dataset path
       #
       # @example
-      #   Dataset.new(config, path: '/users').path
+      #   Dataset.new(path: '/users').path
       #   # => 'users'
       #
       # @return [String] the dataset path, without a leading slash
       #
       # @api public
       def path
-        join_path(base_path, strip_path(options[:path].to_s))
+        join_path(base_path, super)
       end
 
       # Return the dataset path
       #
       # @example
-      #   Dataset.new(config, path: '/users').path
+      #   Dataset.new(path: '/users').path
       #   # => '/users'
       #
-      # @return [string] the dataset path, with leading slash
+      # @return [String] the dataset path, with leading slash
       #
       # @api public
       def absolute_path
@@ -123,7 +203,7 @@ module ROM
       #   To non-destructively add a new header, use `#add_header`
       #
       # @example
-      #   users = Dataset.new(config, headers: { Accept: 'application/json' })
+      #   users = Dataset.new(headers: { Accept: 'application/json' })
       #   users.with_headers(:'X-Api-Key' => '1234').headers
       #   # => { :'X-Api-Key' => '1234' }
       #
@@ -131,7 +211,7 @@ module ROM
       #
       # @api public
       def with_headers(headers)
-        __new__(config, options.merge(headers: headers))
+        with_options(headers: headers)
       end
 
       # Return a new dataset with additional header
@@ -140,7 +220,7 @@ module ROM
       # @param value  [String] the header value
       #
       # @example
-      #   users = Dataset.new(config, headers: { Accept: 'application/json' })
+      #   users = Dataset.new(headers: { Accept: 'application/json' })
       #   users.add_header(:'X-Api-Key', '1234').headers
       #   # => { :Accept => 'application/json', :'X-Api-Key' => '1234' }
       #
@@ -159,7 +239,7 @@ module ROM
       #
       # @api public
       def with_options(opts)
-        __new__(config, options.merge(opts))
+        __new__(options.merge(opts))
       end
 
       # Return a new dataset with a different base path
@@ -204,7 +284,7 @@ module ROM
       #
       # @api public
       def append_path(append_path)
-        with_options(path: join_path(path, append_path))
+        with_path(join_path(options[:path], append_path))
       end
 
       # Return a new dataset with a different request method
@@ -226,7 +306,7 @@ module ROM
       # @param [Hash] params the new request parameters
       #
       # @example
-      #   users = Dataset.new(config, params: { uid: 33 })
+      #   users = Dataset.new(params: { uid: 33 })
       #   users.with_params(login: 'jdoe').params
       #   # => { :login => 'jdoe' }
       #
@@ -242,7 +322,7 @@ module ROM
       # @param [Hash] params the new request parameters to add
       #
       # @example
-      #   users = Dataset.new(config, params: { uid: 33 })
+      #   users = Dataset.new(params: { uid: 33 })
       #   users.add_params(login: 'jdoe').params
       #   # => { uid: 33, :login => 'jdoe' }
       #
@@ -250,10 +330,7 @@ module ROM
       #
       # @api public
       def add_params(new_params)
-        # TODO: Should we merge arrays?
-        with_options(
-          params: ::ROM::HTTP::Transformer[:deep_merge][params, new_params]
-        )
+        with_options(params: ::ROM::HTTP::Transformer[:deep_merge][params, new_params])
       end
 
       # Iterate over each response value
@@ -277,10 +354,7 @@ module ROM
       #
       # @api public
       def insert(params)
-        with_options(
-          request_method: :post,
-          params: params
-        ).response
+        with_options(request_method: :post, params: params).response
       end
 
       # Perform an update over HTTP Put
@@ -291,10 +365,7 @@ module ROM
       #
       # @api public
       def update(params)
-        with_options(
-          request_method: :put,
-          params: params
-        ).response
+        with_options(request_method: :put, params: params).response
       end
 
       # Perform an delete over HTTP Delete
@@ -304,9 +375,7 @@ module ROM
       #
       # @api public
       def delete
-        with_options(
-          request_method: :delete
-        ).response
+        with_options(request_method: :delete).response
       end
 
       # Execute the current dataset
@@ -318,37 +387,19 @@ module ROM
         response_handler.call(request_handler.call(self), self)
       end
 
-      private
-
-      def response_handler
-        response_handler = config.fetch(
-          :response_handler,
-          self.class.config.default_response_handler
-        )
-        fail Error, '+default_response_handler+ configuration missing' if response_handler.nil?
-        response_handler
-      end
+      memoize :uri, :absolute_path
 
-      def request_handler
-        request_handler = config.fetch(
-          :request_handler,
-          self.class.config.default_request_handler
-        )
-        fail Error, '+default_response_handler+ configuration missing' if request_handler.nil?
-        request_handler
-      end
+      private
 
+      # @api private
       def __new__(*args, &block)
         self.class.new(*args, &block)
       end
 
+      # @api private
       def join_path(*paths)
         paths.reject(&:empty?).join(PATH_SEPARATOR)
       end
-
-      def strip_path(path)
-        path.sub(%r{\A/}, '')
-      end
     end
   end
 end