rom-http 0.7.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5fd07f83166373c0e0f2bfe8c83f8f68578818dc
-  data.tar.gz: e643299868045661adadfd6ea6881cf59feda4fe
+SHA256:
+  metadata.gz: f7be96043fffc0399b99aba04e426d0600b8f88e3a90725b6566fab079476b1f
+  data.tar.gz: a94c64dd5d3091a875e2691c6d2d5380ec056b9667d206b43376022ad37be85f
 SHA512:
-  metadata.gz: 2a2de5a39a3cf600c2464250809a2e292c7abef3a8e1b2e79232ac035b14992a160a56035c5c7a65414ab60b643093ac375e234ffab952c6a262f3517cd146fd
-  data.tar.gz: 44315f4744aa86c60fb92c801bd1521e2834dbada29fd53a6cfc4a6f35f27fb09cb335719d9bb4b52be5f1bda9c549539f4e98c96fca2344640c2e7b0a096062
+  metadata.gz: e89e4e48537fbe0a14b770e4069f931f24d8418357adfc179fb1ee72b933b88a82132b7d9abd8baef42b7dd8d1868b8ada2a74f93dae67c06f6b53f3f4265d4f
+  data.tar.gz: 7fbd7ff1d889affbcc4530af2fd8b08f440af929ba3e1efa99f234c454f04c2fd14fdacdd21be6fb8688c21481f6cff35cdc4c61f3527f899cb23ebd1a131656

data/CHANGELOG.md

@@ -1,20 +1,45 @@
-# v0.7.0 2018-01-11
+<!--- DO NOT EDIT THIS FILE - IT'S AUTOMATICALLY GENERATED VIA DEVTOOLS --->
+
+## 0.9.0 2022-09-27
 
 ### Added
-  - Add Dataset#add_params(AMHOL)
+
+- Support for associations :tada: (@ianks)
+- Support for ruby 3 (@AMHOL)
 
 ### Changed
+- Request params separated into query_params and body_params (@AMHOL in [#44](https://github.com/rom-rb/rom-http/pull/44))
+- Minimal ruby version is set to 2.7 (@flash-gordon)
+
+### Fixed
+
+- Warning message from dry-configurable (@gkostin1966)
+
+[Compare v0.8.0...v0.9.0](https://github.com/rom-rb/rom-http/compare/v0.8.0...v0.9.0)
+
+## 0.8.0 2019-04-29
+
+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)
+
+### Fixed
+
+- `Relation#append_path` no longer duplicates `base_path` (solnic)
+
+  - Add Dataset#add_params(AMHOL)
+
   - Updated error messages (AMHOL)
   - updated to depend on ROM 4.0 (maximderbin)
   - 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
-### Changed
   - Make schemas mandatory and use schema API from ROM core (AMHOL)
   - Generate transformer using schema (AMHOL)
   - Removed rbx-2 support (solnic)
@@ -25,47 +50,75 @@
   - Transform keys on insert and update (maximderbin)
   - Remove `rom-support` dependency (maximderbin)
 
-[Compare v0.5.0...v0.6.0](https://github.com/rom-rb/rom-http/compare/v0.5.0...v0.6.0)
-
-# v0.5.0 2016-08-08
-### Changed
   - Removed ruby 2.0 support
   - Use `schema` API from ROM::Core.  Replaces old schema (solnic)
   - Now works out of the box with `rom-repository` (solnic)
 
-[Compare v0.4.0...v0.5.0](https://github.com/rom-rb/rom-http/compare/v0.4.0...v0.5.0)
+  - updated to depend on the forthcoming rom 2.0 (cflipse)
+
+  - replaced dry-data with dry-types  (Nikita Shilnikov <ns@latera.ru>)
+
+
+  - schema support using `dry-data` (AMHOL)
+
+
+  - Projections (`container.relation(:users).project(:id, :name)`) (AMHOL)
+
+
+  - `ROM::HTTP::Dataset` macros for setting `default_request_handler` and `default_response_handler` (AMHOL)
 
-# v0.4.0 2016-04-30
 ### Changed
-  - updated to depend on the forthcoming rom 2.0 (cflipse)
+
+- 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`
+
+[Compare v0.7.0...v0.8.0](https://github.com/rom-rb/rom-http/compare/v0.7.0...v0.8.0)
+
+## 0.7.0 2018-01-11
+
+
+
+[Compare v0.6.0...v0.7.0](https://github.com/rom-rb/rom-http/compare/v0.6.0...v0.7.0)
+
+## 0.6.0 2017-02-06
+
+
+
+[Compare v0.5.0...v0.6.0](https://github.com/rom-rb/rom-http/compare/v0.5.0...v0.6.0)
+
+## 0.5.0 2016-08-08
+
+
+
+[Compare v0.4.0...v0.5.0](https://github.com/rom-rb/rom-http/compare/v0.4.0...v0.5.0)
+
+## 0.4.0 2016-04-30
+
+
 
 [Compare v0.3.0...v0.4.0](https://github.com/rom-rb/rom-http/compare/v0.3.0...v0.4.0)
 
-# v0.3.0 2016-03-17
+## 0.3.0 2016-03-17
+
 
-### Changed
-  - replaced dry-data with dry-types  (Nikita Shilnikov <ns@latera.ru>)
 
 [Compare v0.2.0...v0.3.0](https://github.com/rom-rb/rom-http/compare/v0.2.0...v0.3.0)
 
-# v0.2.0 2016-01-30
-### Added
+## 0.2.0 2016-01-30
+
 
-  - schema support using `dry-data` (AMHOL)
 
 [Compare v0.1.2...v0.2.0](https://github.com/rom-rb/rom-http/compare/v0.1.2...v0.2.0)
 
-# v0.1.2 2015-09-16
-### Added
+## 0.1.2 2015-09-16
+
 
-  - Projections (`container.relation(:users).project(:id, :name)`) (AMHOL)
 
 [Compare v0.1.1...v0.1.2](https://github.com/rom-rb/rom-http/compare/v0.1.1...v0.1.2)
 
-# v0.1.1 2015-09-03
-### Added
+## 0.1.1 2015-09-03
 
-  - `ROM::HTTP::Dataset` macros for setting `default_request_handler` and `default_response_handler` (AMHOL)
 
 ### Changed
 
@@ -75,6 +128,6 @@
 
 [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
+## 0.1.0 2015-08-19
 
 First public release \o/

data/README.md

@@ -1,195 +1,29 @@
 [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
+[actions]: https://github.com/rom-rb/rom-http/actions
+[codacy]: https://www.codacy.com/gh/rom-rb/rom-http
+[chat]: https://rom-rb.zulipchat.com
 [inchpages]: http://inch-ci.org/github/rom-rb/rom-http
-[gitter]: https://gitter.im/rom-rb/chat
-[rom]:  https://github.com/rom-rb/rom
 
-
-# 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-%23346b7a.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]
-
-HTTP adapter for [Ruby Object Mapper][rom]
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-```ruby
-gem 'rom-http'
-```
+[![CI Status](https://github.com/rom-rb/rom-http/workflows/ci/badge.svg)][actions]
+[![RuboCop](https://github.com/rom-rb/rom-http/actions/workflows/rubocop.yml/badge.svg)](https://github.com/rom-rb/rom-http/actions/workflows/rubocop.yml)
+[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/d37d66bb711d4aeebf5e1c1650aee261)][codacy]
+[![Inline docs](http://inch-ci.org/github/rom-rb/rom-http.svg?branch=main)][inchpages]
 
-And then execute:
+## Links
 
-    $ bundle
+* [User documentation](http://rom-rb.org/learn/http)
+* [API documentation](http://rubydoc.info/gems/rom-http)
 
-Or install it yourself as:
+## Supported Ruby versions
 
-    $ gem install rom-http
-
-## ROADMAP
-
-For details please refer to [issues](https://github.com/rom-rb/rom-http/issues).
+This library officially supports the following Ruby versions:
 
+* MRI >= `2.7`
+* ~jruby >= `9.3`~ (awaits Ruby 2.7 compatibility)
 
 ## License
 
 See `LICENSE` file.
-
-## Synopsis
-
-```ruby
-require 'inflecto'
-require 'json'
-require 'uri'
-require 'net/http'
-
-class RequestHandler
-  def call(dataset)
-    uri = dataset.uri
-    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
-    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
-
-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)
-container = ROM.container(configuration)
-
-container.relation(:users).by_id(1).to_a
-# => GET http://jsonplaceholder.typicode.com/users/1 [ Accept: application/json ]
-```
-
-### Extending
-
-```ruby
-require 'inflecto'
-require 'json'
-require 'uri'
-require 'net/http'
-
-module ROM
-  module MyAdapter
-    class Dataset < ROM::HTTP::Dataset
-      configure do |config|
-        config.default_request_handler = ->(dataset) do
-          uri = dataset.uri
-
-          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
-
-        config.default_response_handler = ->(response, dataset) do
-          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
-    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::Update
-        adapter :my_adapter
-      end
-
-      class Delete < ROM::HTTP::Commands::Delete
-        adapter :my_adapter
-      end
-    end
-  end
-end
-
-ROM.register_adapter(:my_adapter, ROM::MyAdapter)
-
-configuration = ROM::Configuration.new(:my_adapter, {
-  uri: 'http://jsonplaceholder.typicode.com',
-  headers: {
-    Accept: 'application/json'
-  }
-})
-
-class Users < ROM::Relation[:my_adapter]
-  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)
-  end
-end
-
-configuration.register_relation(Users)
-container = ROM.container(configuration)
-
-container.relation(:users).by_id(1).to_a
-# => GET http://jsonplaceholder.typicode.com/users/1 [ Accept: application/json ]
-```

data/lib/rom/http/associations/many_to_many.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rom/associations/many_to_many"
+
+module ROM
+  module HTTP
+    module Associations
+      class ManyToMany < ROM::Associations::ManyToMany
+      end
+    end
+  end
+end

data/lib/rom/http/associations/many_to_one.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rom/associations/many_to_one"
+
+module ROM
+  module HTTP
+    module Associations
+      # ManyToOne implementation
+      class ManyToOne < ROM::Associations::ManyToOne
+        def call(target: self.target)
+          raise MissingAssociationViewError, "must override view" unless view
+
+          schema = target.schema.qualified
+          relation = target
+          apply_view(schema, relation)
+        end
+      end
+    end
+  end
+end

data/lib/rom/http/associations/one_to_many.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require "rom/associations/one_to_many"
+
+module ROM
+  module HTTP
+    module Associations
+      # OneToMany implementation
+      class OneToMany < ROM::Associations::OneToMany
+        def call(target: self.target)
+          raise MissingAssociationViewError, "must override view" unless view
+
+          schema = target.schema.qualified
+          relation = target
+          apply_view(schema, relation)
+        end
+      end
+    end
+  end
+end

data/lib/rom/http/associations/one_to_one.rb

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "rom/http/associations/one_to_many"
+
+module ROM
+  module HTTP
+    module Associations
+      class OneToOne < OneToMany
+      end
+    end
+  end
+end

data/lib/rom/http/associations.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+require "rom/http/associations/many_to_many"
+require "rom/http/associations/one_to_many"
+require "rom/http/associations/many_to_one"
+require "rom/http/associations/one_to_one"
+
+module ROM
+  module HTTP
+    module Associations
+      class MissingAssociationViewError < Error; end
+    end
+  end
+end

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/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/commands.rb

@@ -1,4 +1,6 @@
-require 'rom/commands'
-require 'rom/http/commands/create'
-require 'rom/http/commands/update'
-require 'rom/http/commands/delete'
+# frozen_string_literal: true
+
+require "rom/commands"
+require "rom/http/commands/create"
+require "rom/http/commands/update"
+require "rom/http/commands/delete"