rest-in-peace 4.2.1 → 5.0.0

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    ZWE2NzNkZWMyZWI4ZjBhODBjNTljNWZkZjMyYTM3MTY0NjZmYWY4ZQ==
-  data.tar.gz: !binary |-
-    YTFhOTVlNGI1NjA1ZWE3OTE1ZThhMWNkMjJlZjE1MDIxMDc3OWQ4Zg==
+SHA1:
+  metadata.gz: b1b164cd072c9e5feed0664b99ce7a65d9308277
+  data.tar.gz: 368a7a06efc5bcc51f731de460d52445193d45d0
 SHA512:
-  metadata.gz: !binary |-
-    MTM1YjViZjJkMDcwNGI5NzEwMWRjYjhiY2VhMmIwNzk2MzMzNzRiZGUwNDAz
-    YWY0NmRmZjNiNjExZWFlYzRhZjY0OGFjZTkxMWYyOGRhMTFiYjY1NDBkODI0
-    MWM4NjQ2ZjU4NTQwYjdlMWY1YzExYzEwNmFkMDRiMzViMzZiZDA=
-  data.tar.gz: !binary |-
-    ZmQ0Mjg0ZGMwZmNiNDVkZjk5ZjU3MzY0MDM2ODBlNDRkMDI4MjNlZGE2MWYw
-    NTFjZDMwN2FiMDVkNWJlOTc2ZjliOTVlZDQ0ZTg2YTlmNjMwNWUyMzhmNmRj
-    ZjA3OWFmZTc1ODU1YzAzNTAwMDBkYzg0NGJkYTAxM2E5ZTRmNTA=
+  metadata.gz: e43b2dfa0f0c1fb9bbc96186e8034b63ce0a373351731ef08b8755f36ed4c853f3cfc72518b50ea52e1e44401b545baaf9664b06cade4ad0ffe78fc2a94bbe99
+  data.tar.gz: f20641b4c22b64451ebd5e8acc99543888cc210c8ab1686e8c91c73d1edd47172a392635c4e0f52f108f2155da56ff2ac48153616cba0288f4b1a057e742df5b

data/.ruby-version

@@ -1 +1 @@
-1.9.3-p547
+2.2.4

data/.travis.yml

@@ -11,3 +11,4 @@ gemfile:
   - gemfiles/Gemfile.rails-4.2.x
 script:
   - bundle exec rake spec
+before_install: gem install bundler

data/README.md

@@ -97,8 +97,6 @@ resource.create # calls "POST /rip"
 resource.reload # calls "GET /rip/1"
 ```
 
-**For any writing action (`:post`, `:put`, `:patch`) RESTinPeace will include the *changed* attributes in the body and `id`.**
-
 #### Collection
 
 If you define anything inside the `collection` block, it will define a method on the class:
@@ -119,6 +117,19 @@ resource = Resource.find(id: 1) # calls "GET /rip/1"
 resource = Resource.find_on_other(other_id: 42, id: 1337) # calls "GET /other/42/rip/1337"
 ```
 
+#### HTTP Verb differences
+
+Depending on the given HTTP verb, a different set of attributes will be used as payload and query parameters.
+
+HTTP Verb           | passed | all | only changed and id | only id
+------------------- | :----: | :-: | :-----------------: | :-----:
+`GET` on collection | ✔      | ✘   | ✘                   | ✘
+`GET` on resource   | ✘      | ✔   | ✘                   | ✘
+`POST`              | ✘      | ✔   | ✘                   | ✘
+`PUT`               | ✘      | ✔   | ✘                   | ✘
+`PATCH`             | ✘      | ✘   | ✔                   | ✘
+`DELETE`            | ✘      | ✘   | ✘                   | ✔
+
 #### Pagination
 
 You can define your own pagination module which will be mixed in when calling the API:

data/VERSION

@@ -1 +1 @@
-4.2.1
+5.0.0

data/examples/pagination_with_headers.rb

@@ -15,7 +15,7 @@ module MyClient
 
           # Only make a request to get the next page if we have not
           # reached the last page yet.
-          raise StopIteration if current_page == total_pages
+          raise StopIteration if current_page >= total_pages
           @params.merge!(page: current_page + 1)
           result = api.get(url, @params)
           current_page = result.env.response_headers['X-Page'].to_i

data/lib/rest_in_peace/definition_proxy/resource_method_definitions.rb

@@ -24,7 +24,7 @@ module RESTinPeace
       def post(method_name, url_template)
         @target.rip_registry[:resource] << { method: :post, name: method_name, url: url_template }
         @target.send(:define_method, method_name) do
-          call = RESTinPeace::ApiCall.new(api, url_template, self, payload)
+          call = RESTinPeace::ApiCall.new(api, url_template, self, payload(false))
           call.post
         end
       end
@@ -32,7 +32,7 @@ module RESTinPeace
       def put(method_name, url_template)
         @target.rip_registry[:resource] << { method: :put, name: method_name, url: url_template }
         @target.send(:define_method, method_name) do
-          call = RESTinPeace::ApiCall.new(api, url_template, self, payload)
+          call = RESTinPeace::ApiCall.new(api, url_template, self, payload(false))
           call.put
         end
       end

data/lib/rest_in_peace/template_sanitizer.rb

@@ -18,7 +18,7 @@ module RESTinPeace
       tokens.each do |token|
         param = @params.delete(token.to_sym)
         param ||= @klass.send(token) if @klass.respond_to?(token)
-        raise IncompleteParams, "Unknown parameter for token :#{token} found" unless param
+        raise IncompleteParams, "No parameter for token :#{token} found" unless param
         @url.sub!(%r{:#{token}}, param.to_s)
       end
       @url

data/lib/rest_in_peace.rb

@@ -17,11 +17,15 @@ module RESTinPeace
     set_attributes attributes
   end
 
-  def payload
+  def payload(changes_only = true)
     hash_representation = { id: id }
-    changed.each do |key|
-      value = send(key)
-      hash_representation[key.to_sym] = hash_representation_of_object(value)
+    if changes_only
+      changed.each do |key|
+        value = send(key)
+        hash_representation[key.to_sym] = hash_representation_of_object(value)
+      end
+    else
+      hash_representation = to_h
     end
     if self.class.rip_namespace
       { id: id, self.class.rip_namespace => hash_representation }

data/spec/rest_in_peace/definition_proxy/resource_method_definitions_spec.rb

@@ -37,7 +37,20 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
   end
 
-  shared_examples_for 'an instance method with parameters' do
+  shared_examples_for 'an instance method with all attributes' do
+    describe 'parameter and arguments handling' do
+      it 'uses all the attributes of the class' do
+        expect(RESTinPeace::ApiCall).to receive(:new).
+          with(target.api, url_template, instance, instance.payload(false)).
+          and_return(api_call_double)
+
+        subject.send(http_verb, method_name, url_template)
+        instance.send(method_name)
+      end
+    end
+  end
+
+  shared_examples_for 'an instance method with changed attributes' do
     describe 'parameter and arguments handling' do
       it 'uses the attributes of the class' do
         expect(RESTinPeace::ApiCall).to receive(:new).
@@ -50,7 +63,7 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
   end
 
-  shared_examples_for 'an instance method without parameters' do
+  shared_examples_for 'an instance method without attributes' do
     describe 'parameter and arguments handling' do
       it 'provides the id only' do
         expect(RESTinPeace::ApiCall).to receive(:new).
@@ -71,7 +84,7 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
 
     describe 'the created method' do
-      it_behaves_like 'an instance method with parameters' do
+      it_behaves_like 'an instance method with changed attributes' do
         let(:http_verb) { :get }
         let(:method_name) { :reload }
         let(:url_template) { '/a/:id' }
@@ -87,7 +100,7 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
 
     describe 'the created method' do
-      it_behaves_like 'an instance method with parameters' do
+      it_behaves_like 'an instance method with changed attributes' do
         let(:http_verb) { :patch }
         let(:method_name) { :save }
         let(:url_template) { '/a/:id' }
@@ -103,7 +116,7 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
 
     describe 'the created method' do
-      it_behaves_like 'an instance method with parameters' do
+      it_behaves_like 'an instance method with all attributes' do
         let(:http_verb) { :post }
         let(:method_name) { :create }
         let(:url_template) { '/a/:id' }
@@ -119,7 +132,7 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
 
     describe 'the created method' do
-      it_behaves_like 'an instance method with parameters' do
+      it_behaves_like 'an instance method with all attributes' do
         let(:http_verb) { :put }
         let(:method_name) { :update }
         let(:url_template) { '/a/:id' }
@@ -135,7 +148,7 @@ describe RESTinPeace::DefinitionProxy::ResourceMethodDefinitions do
     end
 
     describe 'the created method' do
-      it_behaves_like 'an instance method without parameters' do
+      it_behaves_like 'an instance method without attributes' do
         let(:http_verb) { :delete }
         let(:method_name) { :destroy }
         let(:url_template) { '/a/:id' }

metadata

@@ -1,121 +1,121 @@
 --- !ruby/object:Gem::Specification
 name: rest-in-peace
 version: !ruby/object:Gem::Version
-  version: 4.2.1
+  version: 5.0.0
 platform: ruby
 authors:
 - Raffael Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-07-31 00:00:00.000000000 Z
+date: 2016-01-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3.2'
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '3.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.6'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 2.6.1
 - !ruby/object:Gem::Dependency
   name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '4.2'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.2.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.8'
-    - - ! '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.2
 description: Let your api REST in peace.
@@ -125,11 +125,11 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
-- .ruby-gemset
-- .ruby-version
-- .travis.yml
+- ".gitignore"
+- ".rspec"
+- ".ruby-gemset"
+- ".ruby-version"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -176,17 +176,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.5.1
 signing_key: 
 specification_version: 4
 summary: REST in peace