smooth_operator 1.22.6 → 1.30.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    NzdmNTA5NmYzMTU2YzczNzYyYjRlOTdlMDkwMDRkOTlmNTI3YjBiYQ==
+    ZGJiZDVhYzQxYmIwMjNkZDcyZWI2ZWYwNzA5YTdkNDdlN2UzMGFjZg==
   data.tar.gz: !binary |-
-    MmI2Mjc0YWUyYTA0MWIyZjYxNDc0N2EzZDA5Zjg1ZjIzNTk0MDBlNQ==
+    MjBkM2NhMWRjMThmZTg2NmM1NzA4MjVjNzM2ZTdjOTBjZjU3Mjk0OQ==
 SHA512:
   metadata.gz: !binary |-
-    N2QyOTcwYzdhMWM1YzkzYTZhMDBjMjA4NjI1NWUwZWM4NWRkZmJjMWQ2N2Vi
-    MDZhMjQxYTA0OGFiNDYyZjUyODc0YzBkNThjNGJmOWEzMjJkNDE5OGNlZTUx
-    ZDIwOTI2YmY0NGZhNDNiYjQyYWVhZWRjYmU4NjMxZmEwMDBhNGQ=
+    YzdlZWMwN2VkMDE4N2EwNjZkMjBhZmM0MzZmMTY5ZDU5Nzg1NzJiNjBkNjE2
+    NzRhYjVmZDJhNGE4MWIwMTBhZTExZWJjZmRmODBiMzI2ZGQ3MjliMWM1OTFl
+    NmEzOWNhMjRiNmQ1ZmJlNzAzMTY4ZWFiZmViMjE4ZjRmN2NmNDE=
   data.tar.gz: !binary |-
-    YmE4NTgxNWQwMGM1NDJjMTk5ODU2ZTVmOGYzYzA1MjFlZWM5MzFhZWFkNzdl
-    OTNlMDA1N2VkMDlkMmYzMjhiNmE1Y2EyZjJjOWVlOTk2NzY3MjJlNDcwNDI2
-    NmM0MzQ3N2M0YmViYjZkMzc0ODZjNDk3OTdiYzU3NTQ5ZDZkNTk=
+    MDA1MDc3NzQxMWQ4ZDYwYzhlZjc3ZmI5YmRiNzgwMTVkMGUyNmVmN2JjZWYx
+    YmU2NDE2OTI0OGU1YWIyYTczM2VmMGMzY2NhN2Y4M2M0NWIyMDVhNzUzOTc0
+    MjYyYmUwYWQyNmQxOTNjMzJiNTQyMDhkZTE2NGFiZGU2OTgyNzQ=

data/README.md

@@ -37,11 +37,14 @@ Or install it yourself as:
 
 ```ruby
 class MyBlogResource < SmoothOperator::Base
-  self.endpoint = 'http://myblog.com/api/v0'
 
   # HTTP BASIC AUTH
-  self.endpoint_user = 'admin'
-  self.endpoint_pass = 'admin'
+  options endpoint_user: 'admin',
+          endpoint_pass: 'admin',
+          endpoint: 'http://myblog.com/api/v0'
+
+  # OR
+  # smooth_operator_options
 end
 
 class Post < MyBlogResource
@@ -134,7 +137,9 @@ post.save('/save_and_add_to_list')
 ### 2.4) Saving using HTTP Patch verb
 ```ruby
 class Page < MyBlogResource
-  self.update_http_verb = :patch
+  options update_http_verb: 'patch'
+  # OR
+  #smooth_operator_options update_http_verb: 'patch'
 end
 
 page = Page.find(2)
@@ -241,13 +246,13 @@ Models
   ```ruby
   class SmoothResource < SmoothOperator::Rails
 
-    def self.headers
-      headers = super
+    options headers: :custom_headers
 
-      headers.merge({
+    def self.custom_headers
+      {
         cookie: current_user.blog_cookie,
         "X_CSRF_TOKEN" => current_user.blog_auth_token
-      })
+      }
     end
 
     protected ############## PROTECTED #################

data/lib/smooth_operator.rb

@@ -23,7 +23,7 @@ module SmoothOperator
     include Persistence
     include FinderMethods
 
-    self.strict_behaviour = true
+    options strict_behaviour: true
 
     def self.smooth_operator?
       true
@@ -38,7 +38,7 @@ module SmoothOperator
       include ActiveModel::Validations::Callbacks
       include ActiveModel::Conversion
 
-      self.unknown_hash_class = SmoothOperator::OpenStruct
+      options unknown_hash_class: SmoothOperator::OpenStruct
 
       validate :validate_induced_errors, :validate_nested_objects
 

data/lib/smooth_operator/associations.rb

@@ -29,11 +29,9 @@ module SmoothOperator
     end
 
     def rails_serialization
-      Helpers.get_instance_variable(self, :rails_serialization, false)
+      get_option :rails_serialization, false
     end
 
-    attr_writer :rails_serialization
-
     protected ###################### PROTECTED ###################
 
     # TODO: THIS MUST GO TO A HELPER_METHODS MODULE

data/lib/smooth_operator/attribute_assignment.rb

@@ -67,10 +67,8 @@ module SmoothOperator
 
     module ClassMethods
 
-      attr_writer :unknown_hash_class
-
       def unknown_hash_class
-        Helpers.get_instance_variable(self, :unknown_hash_class, ::OpenStruct)
+        get_option :unknown_hash_class, ::OpenStruct
       end
 
       def attributes_white_list

data/lib/smooth_operator/delegation.rb

@@ -24,11 +24,9 @@ module SmoothOperator
     module ClassMethods
 
       def strict_behaviour
-        Helpers.get_instance_variable(self, :strict_behaviour, false)
+        get_option :strict_behaviour, false
       end
 
-      attr_writer :strict_behaviour
-
     end
 
   end

data/lib/smooth_operator/open_struct.rb

@@ -1,3 +1,4 @@
+require "smooth_operator/options"
 require "smooth_operator/delegation"
 require "smooth_operator/validations"
 require "smooth_operator/resource_name"
@@ -8,6 +9,7 @@ require "smooth_operator/attribute_assignment"
 module SmoothOperator
   class OpenStruct
 
+    extend Options
     extend ResourceName
 
     include Delegation

data/lib/smooth_operator/operator.rb

@@ -55,17 +55,13 @@ module SmoothOperator
       OPTIONS = [:endpoint, :endpoint_user, :endpoint_pass, :timeout, :server_name]
 
       OPTIONS.each do |option|
-        define_method(option) { Helpers.get_instance_variable(self, option, '') }
+        define_method(option) { get_option option, '' }
       end
 
-      attr_writer *OPTIONS
-
       def headers
-        Helpers.get_instance_variable(self, :headers, {})
+        get_option :headers, {}
       end
 
-      attr_writer :headers
-
       def make_the_call(http_verb, relative_path = '', data = {}, options = {})
         options = HelperMethods.populate_options(self, options)
 

data/lib/smooth_operator/options.rb

@@ -0,0 +1,30 @@
+module SmoothOperator
+  module Options
+
+    def get_option(option, default, *args)
+      return default unless config_options.include?(option)
+
+      _option = config_options[option]
+
+      case _option
+      when Symbol
+        respond_to?(_option) ? send(_option, *args) : _option
+      when Proc
+        _option.call(*args)
+      else
+        _option
+      end
+    end
+
+    def config_options
+      Helpers.get_instance_variable(self, :config_options, {})
+    end
+
+    def smooth_operator_options(options = {})
+      config_options.merge!(options)
+    end
+
+    alias_method :options, :smooth_operator_options
+
+  end
+end

data/lib/smooth_operator/persistence.rb

@@ -49,11 +49,11 @@ module SmoothOperator
     end
 
     def save(relative_path = nil, data = {}, options = {})
-      data = resource_body(data, options)
+      resource_data = resource_data_for_server(data)
 
       method = new_record? ? :create : :update
 
-      make_a_persistence_call(method, relative_path, data, options) do |remote_call|
+      make_a_persistence_call(method, relative_path, resource_data, options) do |remote_call|
         @new_record = false if method == :create && remote_call.status
 
         block_given? ? yield(remote_call) : remote_call.status
@@ -78,14 +78,28 @@ module SmoothOperator
 
     protected ######################### PROTECTED ##################
 
-    def resource_body(data, options)
-      data = Helpers.stringify_keys(data)
+    def internal_data_for_server
+      data = self.class.get_option(:internal_data_for_server, false)
 
-      hash = serializable_hash(options[:serializable_options]).dup
+      if data == false
+        serializable_hash.dup.tap { |hash| hash.delete(self.class.primary_key) }
+      else
+        data
+      end
+    end
+
+    def resource_data_for_server(data)
+      resource_data =
+        self.class.get_option(:resource_data_for_server, false, data)
 
-      hash.delete(self.class.primary_key)
+      if resource_data == false
+        data = Helpers.stringify_keys(data)
+        resource_data = Helpers.stringify_keys(internal_data_for_server)
 
-      { self.class.resource_name => hash }.merge(data)
+        { self.class.resource_name.to_s => resource_data }.merge(data)
+      else
+        resource_data
+      end
     end
 
     private ##################### PRIVATE ##################
@@ -93,7 +107,7 @@ module SmoothOperator
     def make_a_persistence_call(method, relative_path, data, options)
       options ||= {}
 
-      http_verb = options[:http_verb] || self.class.methods_vs_http_verbs[method]
+      http_verb = options[:http_verb] || self.class.http_verb_for(method)
 
       make_the_call(http_verb, relative_path, data, options) do |remote_call|
         @last_remote_call = remote_call
@@ -110,26 +124,16 @@ module SmoothOperator
 
       METHODS_VS_HTTP_VERBS = { reload: :get, create: :post, update: :put, destroy: :delete }
 
-      def methods_vs_http_verbs
-        Helpers.get_instance_variable(self, :methods_vs_http_verbs, METHODS_VS_HTTP_VERBS.dup)
+      def http_verb_for(method)
+        get_option "#{method}_http_verb".to_sym, METHODS_VS_HTTP_VERBS[method]
       end
 
       def primary_key
-        Helpers.get_instance_variable(self, :primary_key, 'id')
+        get_option :primary_key, 'id'
       end
 
-      attr_writer :primary_key
-
       def destroy_key
-        Helpers.get_instance_variable(self, :destroy_key, '_destroy')
-      end
-
-      attr_writer :destroy_key
-
-      METHODS_VS_HTTP_VERBS.keys.each do |method|
-        define_method("#{method}_http_verb=") do |http_verb|
-          methods_vs_http_verbs[method] = http_verb
-        end
+        get_option :destroy_key, '_destroy'
       end
 
       def create(attributes = nil, relative_path = nil, data = {}, options = {})

data/lib/smooth_operator/resource_name.rb

@@ -1,22 +1,14 @@
 module SmoothOperator
   module ResourceName
 
-    def resources_name(default_bypass = nil)
-      return @resources_name if defined?(@resources_name)
-
-      (Helpers.super_method(self, :resources_name, true) || (default_bypass ? nil : self.resource_name.pluralize))
+    def resources_name
+      get_option :resources_name, self.resource_name.pluralize
     end
 
-    attr_writer :resources_name
-
-    def resource_name(default_bypass = nil)
-      return @resource_name if defined?(@resource_name)
-
-      (Helpers.super_method(self, :resource_name, true) || (default_bypass ? nil : self.model_name.to_s.underscore))
+    def resource_name
+      get_option :resource_name, self.model_name.to_s.underscore
     end
 
-    attr_writer :resource_name
-
     def model_name
       return '' if custom_model_name == :none
 

data/lib/smooth_operator/type_casting.rb

@@ -103,7 +103,7 @@ module SmoothOperator
     end
 
     def new_unknown_hash(hash, unknown_hash_class, parent_object)
-      if unknown_hash_class == :none
+      if unknown_hash_class.nil?
         hash
       else
         unknown_hash_class.new(cast_params(hash, unknown_hash_class, parent_object))

data/lib/smooth_operator/validations.rb

@@ -28,11 +28,9 @@ module SmoothOperator
     module ClassMethods
 
       def errors_key
-        Helpers.get_instance_variable(self, :errors_key, 'errors')
+        get_option :errors_key, 'errors'
       end
 
-      attr_writer :errors_key
-
     end
 
   end

data/lib/smooth_operator/version.rb

@@ -1,3 +1,3 @@
 module SmoothOperator
-  VERSION = "1.22.6"
+  VERSION = '1.30.0'
 end

data/spec/smooth_operator/attribute_assignment_spec.rb

@@ -89,7 +89,7 @@ describe SmoothOperator::AttributeAssignment do
         end
       end
 
-      context "when the .unknown_hash_class is set to :none" do
+      context "when the .unknown_hash_class is set to nil" do
         subject { User::UnknownHashClass::None.new(creator: { first_name: 'admin', address: { street: 'something' } }) }
 
         it "the hash will be copied as it is" do

data/spec/support/models/address.rb

@@ -1,12 +1,12 @@
 class Address < SmoothOperator::Base
 
-  self.resource_name = ''
-
-  self.endpoint_user = 'admin'
-  self.endpoint_pass = 'admin'
-
-  self.endpoint = 'http://localhost:4567/'
-
-  self.headers = { "X-APPTOKEN" => "joaquim_app_token", "X-LAYERTOKEN" => "joaquim_layer_token" }
+  options resource_name: '',
+          endpoint_user: 'admin',
+          endpoint_pass: 'admin',
+          endpoint: 'http://localhost:4567/',
+          headers: {
+            "X-APPTOKEN" => "app_token",
+            "X-LAYERTOKEN" => "layer_token"
+          }
 
 end

data/spec/support/models/comment.rb

@@ -1,5 +1,5 @@
 class Comment < SmoothOperator::Base
 
-  self.unknown_hash_class = SmoothOperator::OpenStruct
+  options unknown_hash_class: SmoothOperator::OpenStruct
 
 end

data/spec/support/models/post.rb

@@ -1,14 +1,10 @@
 class Post < SmoothOperator::Base
 
-  self.endpoint_user = 'admin'
-
-  self.endpoint_pass = 'admin'
-
-  self.endpoint = 'http://localhost:4567/'
-
-  self.rails_serialization = true
-
-  self.unknown_hash_class = SmoothOperator::OpenStruct
+  options endpoint_user: 'admin',
+          endpoint_pass: 'admin',
+          rails_serialization: true,
+          endpoint: 'http://localhost:4567/',
+          unknown_hash_class: SmoothOperator::OpenStruct
 
   has_many :comments#, rails_serialization: true
 

data/spec/support/models/user.rb

@@ -2,13 +2,10 @@ module User
 
   class Base < SmoothOperator::Base
 
-    self.resource_name = 'user'
-
-    self.endpoint_user = 'admin'
-
-    self.endpoint_pass = 'admin'
-
-    self.endpoint = 'http://localhost:4567/'
+    options resource_name: 'user',
+            endpoint_user: 'admin',
+            endpoint_pass: 'admin',
+            endpoint: 'http://localhost:4567/'
 
     def self.query_string(params)
       params['query_string_param'] = true
@@ -21,21 +18,21 @@ module User
   module UnknownHashClass
 
     class OpenStructBase < User::Base
-      self.unknown_hash_class = SmoothOperator::OpenStruct
+      options unknown_hash_class: SmoothOperator::OpenStruct
     end
 
     class None < User::Base
-      self.unknown_hash_class = :none
+      options unknown_hash_class: nil
     end
 
   end
 
   class BrokenConnection < SmoothOperator::Base
-    self.endpoint = 'http://localhost:1234/'
+    options endpoint: 'http://localhost:1234/'
   end
 
   class TimeoutConnection < Base
-    self.timeout = 1
+    options timeout: 1
   end
 
 end

data/spec/support/models/user_with_address_and_posts.rb

@@ -2,7 +2,7 @@ module UserWithAddressAndPosts
 
   class Father < User::Base
 
-    self.resource_name = 'user'
+    options resource_name: 'user'
 
     schema(
       posts: Post,
@@ -27,13 +27,13 @@ module UserWithAddressAndPosts
 
   class SoftBehaviour < Son
 
-    self.strict_behaviour = false
+    options strict_behaviour: false
 
   end
 
   class WithPatch < Son
 
-    self.update_http_verb = :patch
+    options update_http_verb: 'patch'
 
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smooth_operator
 version: !ruby/object:Gem::Version
-  version: 1.22.6
+  version: 1.30.0
 platform: ruby
 authors:
 - João Gonçalves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-17 00:00:00.000000000 Z
+date: 2014-07-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -98,6 +98,7 @@ files:
 - lib/smooth_operator/operators/connection_wrapper.rb
 - lib/smooth_operator/operators/faraday.rb
 - lib/smooth_operator/operators/typhoeus.rb
+- lib/smooth_operator/options.rb
 - lib/smooth_operator/persistence.rb
 - lib/smooth_operator/remote_call/base.rb
 - lib/smooth_operator/remote_call/errors/connection_failed.rb