rest-in-peace 1.4.0 → 2.0.0

data/spec/rest_in_peace_spec.rb

@@ -2,13 +2,46 @@ require 'rest_in_peace'
 
 describe RESTinPeace do
 
-  let(:struct) { Struct.new(:name) }
   let(:extended_class) do
-    Class.new(struct) do
+    Class.new do
       include RESTinPeace
+
+      rest_in_peace do
+        attributes do
+          read :id, :name, :relation
+          write :my_array, :my_hash, :array_with_hash, :overridden_attribute
+        end
+      end
+
+      def overridden_attribute
+        'something else'
+      end
+
+      def relation=(v)
+        @relation = v
+      end
+
+      def self_defined_method
+        puts 'yolo'
+      end
     end
   end
-  let(:attributes) { { name: 'test' } }
+  let(:my_array) { %w(element) }
+  let(:name) { 'test' }
+  let(:my_hash) { { element1: 'yolo' } }
+  let(:array_with_hash) { [my_hash.dup] }
+  let(:overridden_attribute) { 'initial value' }
+  let(:attributes) do
+    {
+      id: 1,
+      name: name,
+      relation: { id: 1234 },
+      my_array: my_array,
+      my_hash: my_hash,
+      array_with_hash: array_with_hash,
+      overridden_attribute: overridden_attribute,
+    }
+  end
   let(:instance) { extended_class.new(attributes) }
 
   describe '::api' do
@@ -37,19 +70,109 @@ describe RESTinPeace do
     specify { expect(extended_class.rip_registry).to eq(collection: [], resource: []) }
   end
 
+  describe '::rip_attributes' do
+    subject { extended_class }
+    specify { expect(extended_class).to respond_to(:rip_attributes) }
+    specify do
+      expect(extended_class.rip_attributes).to eq(
+        read: [:id, :name, :relation, :my_array, :my_hash, :array_with_hash, :overridden_attribute],
+        write: [:my_array, :my_hash, :array_with_hash, :overridden_attribute])
+    end
+  end
+
+  describe '::rip_namespace' do
+    subject { extended_class }
+    specify { expect(subject).to respond_to(:rip_namespace) }
+    specify { expect(subject).to respond_to(:rip_namespace=) }
+    it 'allows setting the namespace' do
+      expect { subject.rip_namespace = :blubb }.
+        to change { subject.rip_namespace }.from(nil).to(:blubb)
+    end
+  end
+
   describe '#api' do
     subject { instance }
     specify { expect(subject).to respond_to(:api).with(0).arguments }
   end
 
   describe '#to_h' do
+    subject { instance.to_h }
+    specify { expect(subject).to eq(attributes.merge(overridden_attribute: 'something else')) }
+  end
+
+  describe '#hash_for_updates' do
     subject { instance }
-    specify { expect(subject).to respond_to(:to_h).with(0).arguments }
+    specify { expect(subject).to respond_to(:hash_for_updates).with(0).arguments }
+
+    context 'without a namspace defined' do
+      it 'adds id by default' do
+        expect(subject.hash_for_updates).to include(id: 1)
+      end
+
+      context 'overridden getter' do
+        specify { expect(subject.hash_for_updates).to include(overridden_attribute: 'something else') }
+      end
+
+      context 'self defined methods' do
+        specify { expect(subject).to respond_to(:self_defined_method) }
+        specify { expect(subject.hash_for_updates).to_not include(:self_defined_method) }
+      end
+
+      context 'hash' do
+        specify { expect(subject.hash_for_updates[:my_hash]).to eq(element1: 'yolo') }
+      end
+
+      context 'with objects assigned' do
+        let(:my_hash) { double('OtherClass') }
+        it 'deeply calls hash_for_updates' do
+          expect(my_hash).to receive(:hash_for_updates).and_return({})
+          subject.hash_for_updates
+        end
+      end
+    end
+
+    context 'with a namspace defined' do
+      let(:extended_class) do
+        Class.new do
+          include RESTinPeace
+
+          rest_in_peace do
+            attributes do
+              read :id
+              write :name
+            end
+
+            namespace_attributes_with :blubb
+          end
+        end
+      end
+
+      specify { expect(subject.hash_for_updates).to eq(id: 1, blubb: { id: 1, name: 'test' }) }
+    end
   end
 
   describe '#initialize' do
     subject { instance }
-    specify { expect(subject.name).to eq('test') }
+
+    context 'read only attribute' do
+      specify { expect { subject }.to_not raise_error }
+      specify { expect(subject.name).to eq('test') }
+    end
+
+    context 'write attribute' do
+      context 'via rip defined attribute' do
+        it 'uses the setter' do
+          expect_any_instance_of(extended_class).to receive(:my_array=)
+          subject
+        end
+      end
+      context 'self defined attribute' do
+        it 'uses the setter' do
+          expect_any_instance_of(extended_class).to receive(:relation=)
+          subject
+        end
+      end
+    end
 
     context 'unknown params' do
       let(:attributes) { { name: 'test42', email: 'yolo@example.org' } }
@@ -61,14 +184,24 @@ describe RESTinPeace do
       let(:attributes) { {} }
       specify { expect(subject.name).to eq(nil) }
     end
+
+    context 'read only param' do
+      let(:attributes) { { id: 123 } }
+      specify { expect(subject.id).to eq(123) }
+    end
   end
 
   describe '#update_attributes' do
-    let(:new_attributes) { { name: 'yoloswag' } }
+    let(:new_attributes) { { name: 'yoloswag', my_array: ['yoloswag'] } }
     subject { instance }
     specify do
       expect { subject.update_attributes(new_attributes) }.
-        to change(instance, :name).from(attributes[:name]).to(new_attributes[:name])
+        to change(instance, :my_array).from(attributes[:my_array]).to(new_attributes[:my_array])
+    end
+
+    specify do
+      expect { subject.update_attributes(new_attributes) }.
+        to_not change(instance, :name).from(attributes[:name])
     end
   end
 end

data/spec/spec_helper.rb

@@ -1,6 +1,9 @@
 require 'simplecov'
 SimpleCov.start
 
+require 'i18n'
+I18n.enforce_available_locales = true
+
 RSpec.configure do |config|
   # These two settings work together to allow you to limit a spec run
   # to individual examples or groups you care about by tagging them with
@@ -22,7 +25,7 @@ RSpec.configure do |config|
   # Print the 10 slowest examples and example groups at the
   # end of the spec run, to help surface which specs are running
   # particularly slow.
-  config.profile_examples = 10
+  # config.profile_examples = 10
 
   # Run specs in random order to surface order dependencies. If you find an
   # order dependency and want to debug it, you can fix the order by providing

metadata

@@ -1,20 +1,38 @@
 --- !ruby/object:Gem::Specification
 name: rest-in-peace
 version: !ruby/object:Gem::Version
-  version: 1.4.0
-  prerelease: 
+  version: 2.0.0
 platform: ruby
 authors:
 - Raffael Schmid
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-25 00:00:00.000000000 Z
+date: 2014-08-06 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: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.2'
+    - - <=
+      - !ruby/object:Gem::Version
+        version: '4.1'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -22,7 +40,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -30,7 +47,6 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -38,7 +54,6 @@ dependencies:
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
-    none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
@@ -46,49 +61,61 @@ dependencies:
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
-    none: false
     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
-    none: false
     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
-    none: false
     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
-    none: false
     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
-    none: false
     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
-    none: false
     requirements:
     - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.8.2
 description: Let your api REST in peace.
@@ -113,16 +140,21 @@ files:
 - images/rest_in_peace.gif
 - lib/rest-in-peace.rb
 - lib/rest_in_peace.rb
+- lib/rest_in_peace/active_model_api.rb
 - lib/rest_in_peace/api_call.rb
 - lib/rest_in_peace/definition_proxy.rb
+- lib/rest_in_peace/definition_proxy/attributes_definitions.rb
 - lib/rest_in_peace/definition_proxy/collection_method_definitions.rb
 - lib/rest_in_peace/definition_proxy/resource_method_definitions.rb
 - lib/rest_in_peace/errors.rb
+- lib/rest_in_peace/faraday/raise_errors_middleware.rb
+- lib/rest_in_peace/faraday/ssl_config_creator.rb
 - lib/rest_in_peace/response_converter.rb
-- lib/rest_in_peace/ssl_config_creator.rb
 - lib/rest_in_peace/template_sanitizer.rb
 - rest-in-peace.gemspec
+- 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
@@ -133,30 +165,31 @@ files:
 homepage: http://github.com/ninech/
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23.2
+rubygems_version: 2.4.1
 signing_key: 
-specification_version: 3
+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

data/lib/rest_in_peace/ssl_config_creator.rb

@@ -1,59 +0,0 @@
-require 'openssl'
-
-module RESTinPeace
-  class SSLConfigCreator
-    class MissingParam < Exception; end
-
-    def initialize(config, verify = :peer)
-      @config = config
-      @verify = verify
-
-      raise MissingParam, 'Specify :ca_cert in ssl options' unless @config[:ca_cert]
-      raise MissingParam, 'Specify :client_key in ssl options' unless @config[:client_key]
-      raise MissingParam, 'Specify :client_cert in ssl options' unless @config[:client_cert]
-    end
-
-    def faraday_options
-      {client_cert: client_cert, client_key: client_key, ca_file: ca_cert_path, verify_mode: verify_mode}
-    end
-
-    def client_cert
-      OpenSSL::X509::Certificate.new(open_file(client_cert_path))
-    end
-
-    def client_cert_path
-      path(@config[:client_cert])
-    end
-
-    def client_key
-      OpenSSL::PKey::RSA.new(open_file(client_key_path))
-    end
-
-    def client_key_path
-      path(@config[:client_key])
-    end
-
-    def ca_cert_path
-      path(@config[:ca_cert])
-    end
-
-    def verify_mode
-      case @verify
-      when :peer
-        OpenSSL::SSL::VERIFY_PEER
-      else
-        raise "Unknown verify variant '#{@verify}'"
-      end
-    end
-
-    private
-
-    def open_file(file)
-      File.open(file)
-    end
-
-    def path(file)
-      File.join(file)
-    end
-  end
-end