rest-in-peace 6.0.3 → 6.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4c4599314ea114e10d9395921b8e21da3e354b08
-  data.tar.gz: c434cdd4712d9f840cee88414efe160e3ce3cea3
+  metadata.gz: a4d674276d057a2269ed9800608659da1a067abe
+  data.tar.gz: ed4b76287fe7c704e32b3c4c4e618d56aa113b60
 SHA512:
-  metadata.gz: 6313f2c23659f5ddeee5f374b49758e43c7b59695cab2802cc3e6e026b920865b57e6b718abdf91e84dd6f785d902d3a102a0f96b3024396a66bb645996b5241
-  data.tar.gz: 8b24c6ce07f299b9bc3c26870f4b4385757be82e04eb503244ffd29afa6e397752b6a8e7d6e8f1568f6c679cc833f8d4b3bccb61bf71c9e88d753dec75457c56
+  metadata.gz: 2d904832dd9e7d6ba2e17c09717f1adbe1fb43567e8e20eaf692cb3e713b36490cba74f2058563fafb106c203256f029e31e5156301dab553c66d499c969d9fd
+  data.tar.gz: a585f7ecfea0b4ed82de53ebd430dced0c70479b306b196dca1d43dff5eadd13aef4878735893ee1ed8cb9a38eadea70c46146f59aff274f1a92bce922f564e3

data/.gitignore

@@ -1,3 +1,4 @@
 Gemfile.lock
 coverage
 *.gem
+.bundle

data/.ruby-version

@@ -1 +1 @@
-2.3.3
+2.3.4

data/.travis.yml

@@ -5,12 +5,15 @@ rvm:
   - 2.1.2
   - 2.2.5
   - 2.3.1
+  - 2.3.4
+  - 2.4.1
 gemfile:
   - gemfiles/Gemfile.activemodel-3.2.x
   - gemfiles/Gemfile.activemodel-4.0.x
   - gemfiles/Gemfile.activemodel-4.1.x
   - gemfiles/Gemfile.activemodel-4.2.x
   - gemfiles/Gemfile.activemodel-5.0.x
+  - gemfiles/Gemfile.activemodel-5.1.x
 script:
   - bundle exec rake spec
 before_install: gem install bundler
@@ -20,3 +23,14 @@ matrix:
       gemfile: gemfiles/Gemfile.activemodel-5.0.x
     - rvm: 2.1.2
       gemfile: gemfiles/Gemfile.activemodel-5.0.x
+    - rvm: 2.0.0
+      gemfile: gemfiles/Gemfile.activemodel-5.1.x
+    - rvm: 2.1.2
+      gemfile: gemfiles/Gemfile.activemodel-5.1.x
+notifications:
+  email: false
+  slack:
+    on_success: always
+    on_failure: always
+    rooms:
+      secure: VKDJrfgm1c9OUaQPyMutsVzMCwZzBQh7qxVGJnsdNOHOLtVrc6dQrC6+w7Zc1Py5H5pUU+roKi2n5rVnhNjHf4xukGEdDpI0JBBgYSZjl9b/RbxBsHYG9Z8tUQ0EZ7Bd9H3eH2LHQvjoEcvvUJ6I2BCbXlPCrMovfEB3ILQ8Ryo=

data/README.md

@@ -10,18 +10,51 @@ A ruby REST client that lets you feel like in heaven when consuming APIs.
 
         gem 'rest-in-peace'
 
-2. Choose which http adapter you want to use
+2. Choose which HTTP client you want to use
 
         gem 'faraday'
+        
+3. Choose which HTTP adapter you want to use
+
+        gem 'excon'
 
 ## Usage
 
 ### HTTP Client Library
 
-There is no dependency on a specific HTTP client library but the client has been tested with [Faraday](https://github.com/lostisland/faraday) only. You can use any other client library as long as it has the same API as Faraday.
+This gem depends on the HTTP client library [Faraday](https://github.com/lostisland/faraday). REST-in-Peace has been tested in combination 
+with [Faraday](https://github.com/lostisland/faraday) and [Excon](https://github.com/excon/excon) only. 
 
 ### Configuration
 
+#### HTTP Client
+
+You need to configure and specify the HTTP client library to use. You can either specify a block (for lazy loading) or a client instance directly.
+
+```ruby
+class Resource
+  include RESTinPeace
+    
+  rest_in_peace do
+    use_api ->() do
+      ::Faraday.new(url: 'http://rip.dev', headers: { 'Accept' => 'application/json' }) do |faraday|
+        faraday.request :json
+        faraday.response :json
+        faraday.adapter :excon # make requests with Excon
+      end
+    end
+  end
+end
+
+class ResourceTwo
+  include RESTinPeace
+  
+  rest_in_peace do
+    use_api ->() { MyClient.api }
+  end
+end
+```
+
 #### Attributes
 
 You need to specify all the attributes which should be read out of the parsed JSON. You have to specify whether an attribute
@@ -40,7 +73,7 @@ end
 
 #### API Endpoints
 
-You need to define all the API endpoints you want to consume with `RESTinPeace`. Currently the four HTTP verbs `GET`, `POST`, `PATCH` and `DELETE` are supported.
+You need to define all the API endpoints you want to consume with `REST-in-Peace`. Currently the five verbs `GET`, `POST`, `PUT`, `PATCH` and `DELETE` are supported.
 
 There are two sections where you can specify endpoints: `resource` and `collection`. `collection` supports the HTTP verb `GET` only.
 
@@ -55,28 +88,6 @@ rest_in_peace do
 end
 ```
 
-#### HTTP Client Configuration
-
-You need to specify the HTTP client library to use. You can either specify a block (for lazy loading) or a client instance directly.
-
-```ruby
-class Resource
-  include RESTinPeace
-  
-  rest_in_peace do
-    use_api ->() { Faraday.new(url: 'http://rip.dev') }
-  end
-end
-
-class ResourceTwo
-  include RESTinPeace
-  
-  rest_in_peace do
-    use_api Faraday.new(url: 'http://rip.dev')
-  end
-end
-```
-
 #### Resource
 
 If you define anything inside the `resource` block, it will define a method on the instances of the class:
@@ -160,6 +171,7 @@ For easy interoperability with Rails, there is the ability to include ActiveMode
 
 ```ruby
 require 'rest_in_peace'
+require 'faraday'
 
 module MyClient
   class Fabric
@@ -184,11 +196,14 @@ module MyClient
 end
 ```
 
-#### Complete Configuration
+### Complete Configurations
 
-```ruby
+#### Configured Fabric class with all dependencies
+
+```ruby 
 require 'my_client/paginator'
 require 'rest_in_peace'
+require 'faraday'
 
 module MyClient
   class Fabric
@@ -220,6 +235,72 @@ module MyClient
 end
 ```
 
+#### Configured Fabric class using Faraday
+
+```ruby
+require 'my_client/paginator'
+require 'rest_in_peace'
+require 'faraday'
+
+module MyClient
+  class Fabric
+    include RESTinPeace
+
+    rest_in_peace do
+      use_api ->() do
+        ::Faraday.new(url: 'http://localhost:3001', headers: { 'Accept' => 'application/json' }) do |faraday|
+          faraday.request :json
+          faraday.response :json
+          faraday.adapter :excon
+        end
+      end
+    
+      attributes do
+        read :id
+        write :name
+      end
+
+      resource do
+        patch :save, '/fabrics/:id'
+        post :create, '/fabrics'
+        delete :destroy, '/fabrics/:id'
+        get :reload, '/fabrics/:id'
+      end
+
+      collection do
+        get :all, '/fabrics', paginate_with: MyClient::Paginator
+        get :find, '/fabrics/:id'
+      end
+
+      acts_as_active_model
+    end
+  end
+end
+```
+
+#### CRUD options example of use
+```ruby
+# CREATE
+fabric = MyClient::Fabric.new(name: 'my new fabric')
+fabric.create # calls "POST /fabrics"
+fabric.reload # calls "GET /fabrics/1"
+
+# READ
+last_fabric = MyClient::Fabric.find(id: fabric.id) # calls "GET /fabrics/1"
+
+# UPDATE - first way
+updated_fabric = last_fabric.update_attributes(name: 'first way fabric')
+updated_fabric.save # calls "PATCH /fabrics/1"
+
+# UPDATE - second way 
+updated_fabric = last_fabric.update(name: 'second way fabric') # calls "PATCH /fabrics/1"
+
+# DELETE
+updated_fabric.destroy # calls "DELETE /fabrics/1"
+```
+Method `update_attributes` sets updated value, `save` method stores all changes. This change can be done with calling 
+single line method `update` which do the both things. 
+
 ## Helpers
 
 ### SSL Configuration for Faraday

data/VERSION

@@ -1 +1 @@
-6.0.3
+6.0.4

data/gemfiles/Gemfile.activemodel-5.1.x

@@ -0,0 +1,5 @@
+source 'https://rubygems.org'
+
+gemspec path: '../'
+
+gem 'activemodel', '~> 5.1.2'

data/lib/rest_in_peace/template_sanitizer.rb

@@ -1,4 +1,5 @@
 require 'rest_in_peace/errors'
+require 'addressable/uri'
 
 module RESTinPeace
   class TemplateSanitizer
@@ -16,10 +17,14 @@ module RESTinPeace
       return @url if @url
       @url = @url_template.dup
       tokens.each do |token|
-        param = @params.delete(token.to_sym)
+        param = @params[token.to_sym]
         param ||= @klass.send(token) if @klass.respond_to?(token)
         raise IncompleteParams, "No parameter for token :#{token} found" unless param
-        @url.sub!(%r{:#{token}}, CGI.escape(param.to_s))
+        if @params.include?(token.to_sym)
+          @url.sub!(%r{:#{token}}, CGI.escape(param.to_s))
+        else
+          @url.sub!(%r{:#{token}}, Addressable::URI.parse(param.to_s).normalize.to_s)
+        end
       end
       @url
     end

data/rest-in-peace.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |s|
   s.require_paths = ['lib']
 
   s.add_runtime_dependency 'activemodel', '>= 3.2', '< 6'
+  s.add_runtime_dependency 'addressable', '~> 2.5'
 
   s.add_development_dependency 'rake', '~> 10.0'
   s.add_development_dependency 'rspec', '~> 3.0'

data/spec/rest_in_peace/template_sanitizer_spec.rb

@@ -5,7 +5,6 @@ describe RESTinPeace::TemplateSanitizer do
   let(:attributes) { {} }
   let(:template_sanitizer) { RESTinPeace::TemplateSanitizer.new(url_template, params, klass) }
 
-
   context 'with class' do
     let(:klass) { OpenStruct }
 
@@ -18,6 +17,12 @@ describe RESTinPeace::TemplateSanitizer do
         specify { expect(subject).to eq('/a/1') }
       end
 
+      context 'single token with extra params' do
+        let(:params) { { id: 1, something: 'else' } }
+        let(:url_template) { '/a/:id' }
+        specify { expect(subject).to eq('/a/1') }
+      end
+
       context 'multiple token' do
         let(:params) { { id: 2, a_id: 1 } }
         let(:url_template) { '/a/:a_id/b/:id' }
@@ -118,7 +123,7 @@ describe RESTinPeace::TemplateSanitizer do
         specify { expect { subject }.to raise_error(RESTinPeace::TemplateSanitizer::IncompleteParams) }
       end
 
-      context 'param which need to be encoded' do
+      context 'param which need to be encoded is white space separated string' do
         let(:params) { { id: 'this param need to be encoded' } }
         let(:encoded_param) { 'this+param+need+to+be+encoded' }
         let(:attributes) { { a_id: 2 } }
@@ -126,6 +131,23 @@ describe RESTinPeace::TemplateSanitizer do
         specify { expect(subject).to eq("/a/2/b/#{encoded_param}") }
       end
 
+      context 'path which need to be encoded is white space separated string' do
+        let(:params) { { id: 1 } }
+        let(:attributes) { { a_name: 'with space' } }
+        let(:encoded_path) { 'with%20space' }
+        let(:url_template) { '/a/:a_name/b/:id' }
+        specify { expect(subject).to eq("/a/#{encoded_path}/b/1") }
+      end
+
+      context 'path and param which need to be encoded are white space separated string' do
+        let(:params) { { place: 'dhaini kata' } }
+        let(:encoded_param) { 'dhaini+kata' }
+        let(:attributes) { { a_name: 'with space' } }
+        let(:encoded_path) { 'with%20space' }
+        let(:url_template) { '/a/:a_name/b/:place' }
+        specify { expect(subject).to eq("/a/#{encoded_path}/b/#{encoded_param}") }
+      end
+
       context 'param which need to be encoded is null string' do
         let(:params) { { id: '' } }
         let(:encoded_param) { '' }
@@ -134,6 +156,13 @@ describe RESTinPeace::TemplateSanitizer do
         specify { expect(subject).to eq("/a/2/b/#{encoded_param}") }
       end
 
+      context 'path which need to be encoded is null string' do
+        let(:params) { { id: 1 } }
+        let(:attributes) { { a_name: '' } }
+        let(:url_template) { '/a/:a_name/b/:id' }
+        specify { expect(subject).to eq('/a//b/1') }
+      end
+
       context 'param which need to be encoded is nil' do
         let(:params) { { id: nil } }
         let(:encoded_param) { '' }
@@ -141,6 +170,13 @@ describe RESTinPeace::TemplateSanitizer do
         let(:url_template) { '/a/:a_id/b/:id' }
         specify { expect { subject }.to raise_exception(RESTinPeace::TemplateSanitizer::IncompleteParams) }
       end
+
+      context 'path which need to be encoded is nil' do
+        let(:params) { { id: 1 } }
+        let(:attributes) { { a_name: nil } }
+        let(:url_template) { '/a/:a_name/b/:id' }
+        specify { expect { subject }.to raise_exception(RESTinPeace::TemplateSanitizer::IncompleteParams) }
+      end
     end
 
     describe '#tokens' do

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rest-in-peace
 version: !ruby/object:Gem::Version
-  version: 6.0.3
+  version: 6.0.4
 platform: ruby
 authors:
 - Raffael Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-03-09 00:00:00.000000000 Z
+date: 2017-08-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
@@ -30,6 +30,20 @@ dependencies:
     - - "<"
       - !ruby/object:Gem::Version
         version: '6'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,6 +156,7 @@ files:
 - gemfiles/Gemfile.activemodel-4.1.x
 - gemfiles/Gemfile.activemodel-4.2.x
 - gemfiles/Gemfile.activemodel-5.0.x
+- gemfiles/Gemfile.activemodel-5.1.x
 - images/rest_in_peace.gif
 - lib/rest-in-peace.rb
 - lib/rest_in_peace.rb
@@ -191,14 +206,4 @@ rubygems_version: 2.5.2
 signing_key: 
 specification_version: 4
 summary: REST in peace
-test_files:
-- spec/rest_in_peace/active_model_api_spec.rb
-- spec/rest_in_peace/api_call_spec.rb
-- spec/rest_in_peace/definition_proxy/attributes_definitions_spec.rb
-- spec/rest_in_peace/definition_proxy/collection_method_definitions_spec.rb
-- spec/rest_in_peace/definition_proxy/resource_method_definitions_spec.rb
-- spec/rest_in_peace/definition_proxy_spec.rb
-- spec/rest_in_peace/response_converter_spec.rb
-- spec/rest_in_peace/template_sanitizer_spec.rb
-- spec/rest_in_peace_spec.rb
-- spec/spec_helper.rb
+test_files: []