rom-http 0.5.0 → 0.6.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 940c73eee8219c8b80aa2ec5914549291be5e99d
-  data.tar.gz: 0e852b96a95edb10991aefa9d5bcffa78e5211b4
+  metadata.gz: e61d4626a34ea84673dc4632b6f1bbdd668e0b8c
+  data.tar.gz: 859e9539a8127ad7c8b7cc2fd6d0904cb734e404
 SHA512:
-  metadata.gz: 3db2d4a662ae4ae76138119946b71253e36e0be5653fda789a17083f6915f7630357b0680e297690c56fab85da363ffaee1cc03412d568b2c16bd61421f080db
-  data.tar.gz: 8738e9b3524917c5e74535a2ae6b1ef9e23c82a98871fac7079f507321e40da86185a811f54f1b47468b9b6a56a485891c86f5377f15d13c7246f86703c41fbb
+  metadata.gz: fd492be4654b12a16194c74f2e0ae3db44f4a456b6d8edf85ead74a8f3581ac3bca6bd2d436a67370502c10d416f75692388832249a0e2e53dc4dc05b238cca6
+  data.tar.gz: 666263147a7e6f534d602d6aa904ae8ed28a35c2307799bd871b8312276419750457d5dce5d92218b0c578cf7c7e3f3bea06a4e0b85b034944d2345a28728131

data/.travis.yml

@@ -1,24 +1,21 @@
 language: ruby
-sudo: false
+dist: trusty
+sudo: required
 cache: bundler
 bundler_args: --without sql benchmarks console tools
 script: "bundle exec rake ci"
 rvm:
-  - 2.1
-  - 2.2
-  - 2.3.1
-  - rbx-2
-  - jruby-9.0.5.0
-  - ruby-head
-  - jruby-head
+  - 2.2.6
+  - 2.3.3
+  - 2.4.0
+  - rbx-3
+  - jruby-9.1.6.0
 env:
   global:
     - JRUBY_OPTS='--dev -J-Xmx1024M'
 matrix:
   allow_failures:
-    - rvm: ruby-head
-    - rvm: jruby-head
-    - rvm: rbx-2
+    - rvm: rbx-3
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+# v0.6.0 to-be-released
+# Changed
+  - Make schemas mandatory and use schema API from ROM core (AMHOL)
+  - Generate transformer using schema (AMHOL)
+  - Removed rbx-2 support (solnic)
+  - Add Dataset#base_path and Relation#primary_key (AMHOL)
+  - Updated to work with ROM 3.0.beta (maximderbin)
+  - Removed ruby 2.1 support (maximderbin)
+  - Fix Relation#primary_key when schema defines alias (AMHOL)
+  - Transform keys on insert and update (maximderbin)
+
+[Compare v0.5.0...v0.6.0](https://github.com/rom-rb/rom-http/compare/v0.5.0...master)
+
 # v0.5.0 2016-08-08
 ### Changed
   - Removed ruby 2.0 support

data/README.md

@@ -7,7 +7,7 @@
 [rom]:  https://github.com/rom-rb/rom
 
 
-# ROM-http [![Gitter chat](https://badges.gitter.im/rom-rb/chat.svg)][gitter]
+# rom-http [![Gitter chat](https://badges.gitter.im/rom-rb/chat.svg)][gitter]
 
 [![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]
@@ -45,6 +45,7 @@ See `LICENSE` file.
 ## Synopsis
 
 ```ruby
+require 'inflecto'
 require 'json'
 require 'uri'
 require 'net/http'
@@ -52,11 +53,11 @@ require 'net/http'
 class RequestHandler
   def call(dataset)
     uri = URI(dataset.uri)
-    uri.path = "/#{dataset.name}/#{dataset.path}"
+    uri.path = dataset.absolute_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_klass = Net::HTTP.const_get(Inflecto.classify(dataset.request_method))
 
     request = request_klass.new(uri.request_uri)
     dataset.headers.each_with_object(request) do |(header, value), request|
@@ -69,23 +70,22 @@ end
 
 class ResponseHandler
   def call(response, dataset)
-    Array([JSON.parse(response.body)]).flatten
+    if %i(post put patch).include?(dataset.request_method)
+      JSON.parse(response.body, symbolize_names: true)
+    else
+      Array([JSON.parse(response.body, symbolize_names: true)]).flatten
+    end
   end
 end
 
 class Users < ROM::Relation[:http]
-  dataset :users
-
-  # You can also define a schema block
-  # which will use dry-types' Dry::Types['hash']
-  # coercion to pre-process your data
-  schema do
-    attribute 'id', 'strict.int'
-    attribute 'name', 'strict.string'
-    attribute 'username', 'strict.string'
-    attribute 'email', 'strict.string'
-    attribute 'phone', 'strict.string'
-    attribute 'website', 'strict.string'
+  schema(:users) do
+    attribute :id, ROM::Types::Int
+    attribute :name, ROM::Types::String
+    attribute :username, ROM::Types::String
+    attribute :email, ROM::Types::String
+    attribute :phone, ROM::Types::String
+    attribute :website, ROM::Types::String
   end
 
   def by_id(id)
@@ -111,6 +111,7 @@ container.relation(:users).by_id(1).to_a
 ### Extending
 
 ```ruby
+require 'inflecto'
 require 'json'
 require 'uri'
 require 'net/http'
@@ -120,11 +121,11 @@ module ROM
     class Dataset < ROM::HTTP::Dataset
       default_request_handler ->(dataset) do
         uri = URI(dataset.uri)
-        uri.path = "/#{dataset.name}/#{dataset.path}"
+        uri.path = dataset.absolute_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_klass = Net::HTTP.const_get(Inflecto.classify(dataset.request_method))
 
         request = request_klass.new(uri.request_uri)
         dataset.headers.each_with_object(request) do |(header, value), request|
@@ -135,7 +136,11 @@ module ROM
       end
 
       default_response_handler ->(response, dataset) do
-        Array([JSON.parse(response.body)]).flatten
+        if %i(post put patch).include?(dataset.request_method)
+          JSON.parse(response.body, symbolize_names: true)
+        else
+          Array([JSON.parse(response.body, symbolize_names: true)]).flatten
+        end
       end
     end
 
@@ -171,7 +176,14 @@ configuration = ROM::Configuration.new(:my_adapter, {
 })
 
 class Users < ROM::Relation[:my_adapter]
-  dataset :users
+  schema(:users) do
+    attribute :id, ROM::Types::Int
+    attribute :name, ROM::Types::String
+    attribute :username, ROM::Types::String
+    attribute :email, ROM::Types::String
+    attribute :phone, ROM::Types::String
+    attribute :website, ROM::Types::String
+  end
 
   def by_id(id)
     with_path(id.to_s)

data/examples/repository_with_combine.rb

@@ -0,0 +1,154 @@
+require 'inflecto'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'rom-repository'
+
+class RequestHandler
+  def call(dataset)
+    uri = URI(dataset.uri)
+    uri.path = dataset.absolute_path
+    uri.query = URI.encode_www_form(dataset.params)
+
+    http = Net::HTTP.new(uri.host, uri.port)
+    request_klass = Net::HTTP.const_get(Inflecto.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)
+    if %i(post put patch).include?(dataset.request_method)
+      JSON.parse(response.body, symbolize_names: true)
+    else
+      Array([JSON.parse(response.body, symbolize_names: true)]).flatten
+    end
+  end
+end
+
+class Users < ROM::Relation[:http]
+  schema(:users) do
+    attribute :id, ROM::Types::Int.meta(primary_key: true)
+    attribute :name, ROM::Types::String
+    attribute :username, ROM::Types::String
+    attribute :email, ROM::Types::String
+    attribute :phone, ROM::Types::String
+    attribute :website, ROM::Types::String
+  end
+
+  def by_id(id)
+    with_path(id.to_s)
+  end
+end
+
+class Posts < ROM::Relation[:http]
+  schema(:posts) do
+    attribute :id, ROM::Types::Int.meta(primary_key: true)
+    attribute :userId, ROM::Types::Int.meta(alias: :user_id)
+    attribute :title, ROM::Types::String
+    attribute :body, ROM::Types::String
+  end
+
+  def by_id(id)
+    with_path(id.to_s)
+  end
+
+  def for_user(user)
+    with_options(
+      base_path: 'users',
+      path: "#{user.first[:id]}/posts"
+    )
+  end
+end
+
+class UserRepository < ROM::Repository[:users]
+  relations :posts
+
+  def find(id)
+    users.by_id(id).first
+  end
+
+  def find_with_posts(user_id)
+    users.by_id(user_id).combine_children(many: posts.for_user).first
+  end
+end
+
+configuration = ROM::Configuration.new(:http, {
+  uri: 'http://jsonplaceholder.typicode.com',
+  headers: {
+    Accept: 'application/json'
+  },
+  request_handler: RequestHandler.new,
+  response_handler: ResponseHandler.new
+})
+configuration.register_relation(Users)
+configuration.register_relation(Posts)
+container = ROM.container(configuration)
+
+UserRepository.new(container).find_with_posts(1)
+# =>
+# #<ROM::Struct[User]
+#   id=1
+#   name="Leanne Graham"
+#   username="Bret"
+#   email="Sincere@april.biz"
+#   phone="1-770-736-8031 x56442"
+#   website="hildegard.org"
+#   posts=[
+#     #<ROM::Struct[Post]
+#       id=1
+#       user_id=1
+#       title="sunt aut facere repellat provident occaecati excepturi optio reprehenderit"
+#       body="quia et suscipit\nsuscipit recusandae consequuntur expedita et cum\nreprehenderit molestiae ut ut quas totam\nnostrum rerum est autem sunt rem eveniet architecto">,
+#     #<ROM::Struct[Post]
+#       id=2
+#       user_id=1
+#       title="qui est esse"
+#       body="est rerum tempore vitae\nsequi sint nihil reprehenderit dolor beatae ea dolores neque\nfugiat blanditiis voluptate porro vel nihil molestiae ut reiciendis\nqui aperiam non debitis possimus qui neque nisi nulla">,
+#     #<ROM::Struct[Post]
+#       id=3
+#       user_id=1
+#       title="ea molestias quasi exercitationem repellat qui ipsa sit aut"
+#       body="et iusto sed quo iure\nvoluptatem occaecati omnis eligendi aut ad\nvoluptatem doloribus vel accusantium quis pariatur\nmolestiae porro eius odio et labore et velit aut">,
+#     #<ROM::Struct[Post]
+#       id=4
+#       user_id=1
+#       title="eum et est occaecati"
+#       body="ullam et saepe reiciendis voluptatem adipisci\nsit amet autem assumenda provident rerum culpa\nquis hic commodi nesciunt rem tenetur doloremque ipsam iure\nquis sunt voluptatem rerum illo velit">,
+#     #<ROM::Struct[Post]
+#       id=5
+#       user_id=1
+#       title="nesciunt quas odio"
+#       body="repudiandae veniam quaerat sunt sed\nalias aut fugiat sit autem sed est\nvoluptatem omnis possimus esse voluptatibus quis\nest aut tenetur dolor neque">,
+#     #<ROM::Struct[Post]
+#       id=6
+#       user_id=1
+#       title="dolorem eum magni eos aperiam quia"
+#       body="ut aspernatur corporis harum nihil quis provident sequi\nmollitia nobis aliquid molestiae\nperspiciatis et ea nemo ab reprehenderit accusantium quas\nvoluptate dolores velit et doloremque molestiae">,
+#     #<ROM::Struct[Post]
+#       id=7
+#       user_id=1
+#       title="magnam facilis autem"
+#       body="dolore placeat quibusdam ea quo vitae\nmagni quis enim qui quis quo nemo aut saepe\nquidem repellat excepturi ut quia\nsunt ut sequi eos ea sed quas">,
+#     #<ROM::Struct[Post]
+#       id=8
+#       user_id=1
+#       title="dolorem dolore est ipsam"
+#       body="dignissimos aperiam dolorem qui eum\nfacilis quibusdam animi sint suscipit qui sint possimus cum\nquaerat magni maiores excepturi\nipsam ut commodi dolor voluptatum modi aut vitae">,
+#     #<ROM::Struct[Post]
+#       id=9
+#       user_id=1
+#       title="nesciunt iure omnis dolorem tempora et accusantium"
+#       body="consectetur animi nesciunt iure dolore\nenim quia ad\nveniam autem ut quam aut nobis\net est aut quod aut provident voluptas autem voluptas">,
+#     #<ROM::Struct[Post]
+#       id=10
+#       user_id=1
+#       title="optio molestias id quia eum"
+#       body="quo et expedita modi cum officia vel magni\ndoloribus qui repudiandae\nvero nisi sit\nquos veniam quod sed accusamus veritatis error">
+#   ]>

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

@@ -13,7 +13,6 @@ module ROM
         def execute(tuples)
           Array([tuples]).flatten.map do |tuple|
             attributes = input[tuple]
-            validator.call(attributes)
             relation.insert(attributes.to_h)
           end.to_a
         end

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

@@ -13,7 +13,6 @@ module ROM
         def execute(tuples)
           Array([tuples]).flatten.map do |tuple|
             attributes = input[tuple]
-            validator.call(attributes)
             relation.update(attributes.to_h)
           end.to_a
         end

data/lib/rom/http/dataset.rb

@@ -1,5 +1,4 @@
-require 'rom/http/dataset/response_transformers/schemad'
-require 'rom/http/dataset/response_transformers/schemaless'
+require 'rom/initializer'
 
 module ROM
   module HTTP
@@ -9,17 +8,20 @@ module ROM
     #
     # @api public
     class Dataset
+      PATH_SEPARATOR = '/'.freeze
+      STRIP_PATH = ->(path) { path.sub(%r{\A/}, '') }.freeze
+
       include Enumerable
       include Dry::Equalizer(:config, :options)
-      include ROM::Options
+      extend ::ROM::Initializer
 
-      attr_reader :config
+      param :config
 
-      option :projections, type: ::Array, default: [], reader: true
-      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: {}
+      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 { '' }
+      option :params, type: Types::Hash, default: proc { {} }, reader: true
+      option :headers, type: Types::Hash, default: proc { {} }
 
       class << self
         def default_request_handler(handler = Undefined)
@@ -33,39 +35,6 @@ module ROM
         end
       end
 
-
-      # HTTP Dataset interface
-      #
-      # @param [Hash] config the Gateway's HTTP server configuration
-      #
-      # @param [Hash] options dataset configuration options
-      # @option options [Symbol] :request_method (:get) The HTTP verb to use
-      # @option options [Array]  :projections ([]) Keys to select from response tuple
-      # @option options [String] :path ('') URI request path
-      # @option options [Hash] :headers ({}) Additional request headers
-      # @option options [Hash] :params ({}) HTTP request parameters
-      #
-      # @api public
-      def initialize(config, options = {})
-        @config = config
-        @response_transformer = ResponseTransformers::Schemaless.new
-        super(options)
-      end
-
-      # @overload response_transformer
-      #   Return the current response transformer
-      #
-      # @overload response_transformer(transformer)
-      #   Set a new response transformer
-      #
-      #   @param transformer [#call] The new response transformer
-      #
-      # @api private
-      def response_transformer(transformer = Undefined)
-        return @response_transformer if Undefined === transformer
-        @response_transformer = transformer
-      end
-
       # Return the gateway's URI
       #
       # @return [String]
@@ -104,6 +73,19 @@ module ROM
         config[:name].to_s
       end
 
+      # Return the base path
+      #
+      # @example
+      #   Dataset.new(config, base_path: '/users').base_path
+      #   # => 'users'
+      #
+      # @return [String] the dataset path, without a leading slash
+      #
+      # @api public
+      def base_path
+        STRIP_PATH.call(super)
+      end
+
       # Return the dataset path
       #
       # @example
@@ -114,7 +96,7 @@ module ROM
       #
       # @api public
       def path
-        options[:path].to_s.sub(%r{\A/}, '')
+        STRIP_PATH.call(join_path(base_path, super))
       end
 
       # Return the dataset path
@@ -127,7 +109,7 @@ module ROM
       #
       # @api public
       def absolute_path
-        '/' + path
+        PATH_SEPARATOR + path
       end
 
       # Return a new dataset with given headers
@@ -177,24 +159,19 @@ module ROM
         __new__(config, options.merge(opts))
       end
 
-      # Add a new set projection to the result set
+      # Return a new dataset with a different base path
       #
-      # @param [Array, *args] projections the keys to add to the projections
+      # @param base_path [String] the new base request path
       #
       # @example
-      #   users = Dataset.new(config, projections: [:login])
-      #   users.project(:email, :name).projections
-      #   # => [:login, :email, :name]
+      #   users.with_base_path('/profiles').base_path
+      #   # => 'profiles'
       #
       # @return [Dataset]
       #
       # @api public
-      def project(*args)
-        projections = args.first.is_a?(::Array) ? args.first : args
-
-        with_options(
-          projections: (self.projections + projections)
-        )
+      def with_base_path(base_path)
+        with_options(base_path: base_path)
       end
 
       # Return a new dataset with a different path
@@ -223,8 +200,8 @@ module ROM
       # @return [Dataset]
       #
       # @api public
-      def append_path(path)
-        with_options(path: options[:path] + '/' + path)
+      def append_path(append_path)
+        with_options(path: join_path(path, append_path))
       end
 
       # Return a new dataset with a different request method
@@ -316,10 +293,7 @@ module ROM
       #
       # @api public
       def response
-        response_transformer.call(
-          response_handler.call(request_handler.call(self), self),
-          self
-        )
+        response_handler.call(request_handler.call(self), self)
       end
 
       private
@@ -339,6 +313,10 @@ module ROM
       def __new__(*args, &block)
         self.class.new(*args, &block)
       end
+
+      def join_path(*paths)
+        paths.reject(&:empty?).join(PATH_SEPARATOR)
+      end
     end
   end
 end