smooth_operator 0.4.4 → 1.2.0

data/spec/support/models/user_with_address_and_posts.rb

@@ -0,0 +1,89 @@
+module UserWithAddressAndPosts
+  
+  class Father < User::Base
+    
+    self.resource_name = 'user'
+
+    schema(
+      posts: Post,
+      address: Address
+    )
+
+  end
+
+  class Son < Father
+
+    schema(
+      age: :int,
+      dob: :date,
+      price: :float,
+      manager: :bool,
+      date: :datetime,
+      complex_field: nil,
+      first_name: :string
+    )
+
+  end
+
+  class SoftBehaviour < Son
+
+    self.strict_behaviour = false
+
+  end
+
+  class WithPatch < Son
+
+    self.update_http_verb = :patch
+
+  end
+  
+
+  module UserBlackListed
+    
+    class Father < ::UserWithAddressAndPosts::Son
+
+      attributes_black_list_add "last_name"
+
+    end
+
+    class Son < Father
+
+      attributes_black_list_add :admin
+
+    end
+
+  end
+
+  module UserWhiteListed
+    
+    class Father < ::UserWithAddressAndPosts::Son
+
+      attributes_white_list_add "id"
+
+    end
+
+    class Son < Father
+
+      attributes_white_list_add :first_name
+
+    end
+
+  end
+  
+  class UserWithMyMethod < UserWithAddressAndPosts::Son
+
+    def my_method
+      'my_method'
+    end
+
+  end
+
+  class DirtyAttributes < UserWithAddressAndPosts::Son
+
+    self.dirty_attributes
+
+    self.unknown_hash_class = SmoothOperator::OpenStruct::Dirty
+
+  end
+
+end

data/spec/support/test_server.rb

@@ -0,0 +1,165 @@
+require 'sinatra/base'
+require 'sinatra/json'
+require 'pry'
+
+class TestServer < Sinatra::Base
+
+  use Rack::Auth::Basic, "Restricted Area" do |username, password|
+    username == 'admin' and password == 'admin'
+  end
+
+  get '/posts/:id' do
+    post_data = { id: 1, body: 'from_resource_url' }
+    json post_data
+  end
+
+  get '/users/:id/posts/:id' do
+    post_data = { id: 1, body: 'from_nested_url' }
+    json post_data
+  end
+
+
+  get '/users/test_hash_with_array' do
+    status test_hash_with_array
+  end
+
+  post '/users/test_hash_with_array' do
+    status test_hash_with_array
+  end
+
+  get '/users/test_query_string' do
+    status test_query_string
+  end
+
+  post '/users/test_query_string' do
+    status test_query_string
+  end
+
+
+  get '/users' do
+    users = [FactoryGirl.attributes_for(:user_with_address_and_posts), FactoryGirl.attributes_for(:user_with_address_and_posts)]
+    
+    users[0][:id] = 1
+    users[1][:id] = 2
+
+    json users
+  end
+
+  get '/users/array_with_nested_users' do
+    nested_users = [{ id: 1, first_name: '1' }, { id: 2, first_name: '2' }]
+
+    users = [{ id: 1, users: nested_users}, { id: 2, users: nested_users}]
+
+    json users
+  end
+
+  get '/users/misc_array' do
+    json [FactoryGirl.attributes_for(:user_with_address_and_posts), 2]
+  end
+
+  get '/users/with_metadata' do
+    nested_users = [{ id: 1, first_name: '1' }, { id: 2, first_name: '2' }]
+
+    users = [{ id: 1, users: nested_users}, { id: 2, users: nested_users}]
+
+    data = { page: 1, total: 6, users: users }
+    
+    json data
+  end
+  
+  get '/users/bad_json' do
+    'ok'
+  end
+
+  get '/users/:id' do
+    json FactoryGirl.attributes_for(:user_with_address_and_posts)
+  end
+
+  get '/users/:id/with_metadata' do
+    user_data = { user: FactoryGirl.attributes_for(:user_with_address_and_posts), status: 1 }
+    json user_data
+  end
+  
+
+  put '/users/:id/send_error' do
+    data_with_error = { id: 1, errors: [{ first_name: ["can't be blank"] }] }
+    json data_with_error
+  end
+
+
+  post '/users' do
+    common_response
+  end
+  
+  post '/users/timeout' do
+    # sleep 2 # for typhoeus tests
+    sleep 1
+    json 'ok'
+  end
+
+  put '/users/:id' do
+    common_response
+  end
+  
+  patch '/users/:id' do
+    common_response
+  end
+
+  delete '/users/:id' do
+    common_response
+  end
+
+  not_found do
+    # binding.pry
+  end
+
+
+  protected ################ PROTECTED ################
+
+  def common_response
+    status params[:status]
+
+    data = stringify_data FactoryGirl.attributes_for(:user_with_address_and_posts)
+    data.delete('id')
+
+    query_params = (params[:query_string_param] == 'true')
+    
+    internal_data_match = params[:user] ? (params[:user] == data) : true
+
+    json({ user: { server_response: true }, http_verb: env["REQUEST_METHOD"].downcase, internal_data_match: internal_data_match, query_params: query_params })
+  end
+
+  def test_hash_with_array
+    data = stringify_data FactoryGirl.attributes_for(:user_with_address_and_posts)
+
+    params.delete("query_string_param")
+
+    (params == data) ? 200 : 422
+  end
+
+  def test_query_string
+    params[:normal_param] == 'true' && params[:query_string_param] == 'true' ? 200 : 422
+  end
+
+
+  private ######################### PRIVATE #####################
+
+  def stringify_data(object)
+    if object.is_a?(Hash)
+      data = {}
+      object.each { |key, value| data[key.to_s] = stringify_data(value) }
+      data
+    elsif object.is_a?(Array)
+      object.map { |_value| stringify_data(_value) }
+    else
+      object.to_s
+    end
+  end
+
+  if app_file == $0
+    # require './spec/spec_helper' unless defined? SmoothOperator
+    # require './spec/require_helper' unless defined? SmoothOperator
+    run!
+  end
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: smooth_operator
 version: !ruby/object:Gem::Version
-  version: 0.4.4
+  version: 1.2.0
 platform: ruby
 authors:
 - João Gonçalves
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-13 00:00:00.000000000 Z
+date: 2014-05-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -25,19 +25,47 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '1.3'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :development
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.9
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.8
 description: ActiveResource alternative
 email:
 - goncalves.joao@gmail.com
@@ -46,22 +74,64 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
 - LICENSE.txt
 - README.md
 - Rakefile
+- console.rb
 - lib/smooth_operator.rb
-- lib/smooth_operator/base.rb
-- lib/smooth_operator/core.rb
-- lib/smooth_operator/http_handlers/typhoeus/base.rb
-- lib/smooth_operator/http_handlers/typhoeus/orm.rb
-- lib/smooth_operator/http_handlers/typhoeus/remote_call.rb
-- lib/smooth_operator/operator/base.rb
-- lib/smooth_operator/operator/exceptions.rb
-- lib/smooth_operator/operator/orm.rb
-- lib/smooth_operator/operator/remote_call.rb
+- lib/smooth_operator/array_with_meta_data.rb
+- lib/smooth_operator/attribute_assignment.rb
+- lib/smooth_operator/attribute_methods.rb
+- lib/smooth_operator/attributes/base.rb
+- lib/smooth_operator/attributes/dirty.rb
+- lib/smooth_operator/attributes/normal.rb
+- lib/smooth_operator/delegation.rb
+- lib/smooth_operator/finder_methods.rb
+- lib/smooth_operator/helpers.rb
+- lib/smooth_operator/model_schema.rb
+- lib/smooth_operator/open_struct.rb
+- lib/smooth_operator/operator.rb
+- lib/smooth_operator/operators/faraday.rb
+- lib/smooth_operator/operators/typhoeus.rb
+- lib/smooth_operator/persistence.rb
+- lib/smooth_operator/relation/array_relation.rb
+- lib/smooth_operator/relation/association_reflection.rb
+- lib/smooth_operator/relation/associations.rb
+- lib/smooth_operator/relation/reflection.rb
+- lib/smooth_operator/relation/single_relation.rb
+- lib/smooth_operator/remote_call/base.rb
+- lib/smooth_operator/remote_call/errors/connection_failed.rb
+- lib/smooth_operator/remote_call/errors/timeout.rb
+- lib/smooth_operator/remote_call/faraday.rb
+- lib/smooth_operator/remote_call/typhoeus.rb
+- lib/smooth_operator/serialization.rb
+- lib/smooth_operator/translation.rb
+- lib/smooth_operator/validations.rb
 - lib/smooth_operator/version.rb
 - smooth_operator.gemspec
+- spec/factories/user_factory.rb
+- spec/require_helper.rb
+- spec/smooth_operator/attribute_assignment_spec.rb
+- spec/smooth_operator/attributes_dirty_spec.rb
+- spec/smooth_operator/delegation_spec.rb
+- spec/smooth_operator/finder_methods_spec.rb
+- spec/smooth_operator/model_schema_spec.rb
+- spec/smooth_operator/operator_spec.rb
+- spec/smooth_operator/persistence_spec.rb
+- spec/smooth_operator/remote_call_spec.rb
+- spec/smooth_operator/serialization_spec.rb
+- spec/smooth_operator/validations_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers/persistence_helper.rb
+- spec/support/localhost_server.rb
+- spec/support/models/address.rb
+- spec/support/models/comment.rb
+- spec/support/models/post.rb
+- spec/support/models/user.rb
+- spec/support/models/user_with_address_and_posts.rb
+- spec/support/test_server.rb
 homepage: https://github.com/goncalvesjoao/smooth_operator
 licenses:
 - MIT
@@ -82,10 +152,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: Simple and fully customizable alternative to ActiveResource, based on httparty
-  gem
-test_files: []
-has_rdoc: 
+summary: Simple and fully customizable alternative to ActiveResource, using faraday
+  gem to stablish remote calls"
+test_files:
+- spec/factories/user_factory.rb
+- spec/require_helper.rb
+- spec/smooth_operator/attribute_assignment_spec.rb
+- spec/smooth_operator/attributes_dirty_spec.rb
+- spec/smooth_operator/delegation_spec.rb
+- spec/smooth_operator/finder_methods_spec.rb
+- spec/smooth_operator/model_schema_spec.rb
+- spec/smooth_operator/operator_spec.rb
+- spec/smooth_operator/persistence_spec.rb
+- spec/smooth_operator/remote_call_spec.rb
+- spec/smooth_operator/serialization_spec.rb
+- spec/smooth_operator/validations_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers/persistence_helper.rb
+- spec/support/localhost_server.rb
+- spec/support/models/address.rb
+- spec/support/models/comment.rb
+- spec/support/models/post.rb
+- spec/support/models/user.rb
+- spec/support/models/user_with_address_and_posts.rb
+- spec/support/test_server.rb

data/lib/smooth_operator/base.rb

@@ -1,30 +0,0 @@
-require "smooth_operator/operator/base"
-require "smooth_operator/operator/orm"
-
-require "smooth_operator/http_handlers/typhoeus/base"
-require "smooth_operator/http_handlers/typhoeus/orm"
-
-module SmoothOperator
-
-  class Base < OpenStruct
-    include SmoothOperator::Core
-    include SmoothOperator::Operator::Base
-    include SmoothOperator::Operator::ORM
-
-    protected ################### PROTECTED ###################
-
-    def self.http_handler_base
-      SmoothOperator::HttpHandlers::Typhoeus::Base
-    end
-
-    def self.http_handler_orm
-      @http_handler_orm ||= SmoothOperator::HttpHandlers::Typhoeus::ORM.new(self)
-    end
-
-    def http_handler_orm
-      self.class.http_handler_orm
-    end
-
-  end
-
-end

data/lib/smooth_operator/core.rb

@@ -1,218 +0,0 @@
-module SmoothOperator
-  module Core
-
-    def table_hash
-      @table
-    end
-
-    def as_json(options = nil)
-      @table.as_json(options)
-    end
-
-    def new_record?
-      !persisted?
-    end
-
-    def persisted?
-      try(:id).present?
-    end
-
-    def to_partial_path
-      class_name_plural = self.class.table_name
-      "#{class_name_plural}/#{class_name_plural.singularize}"
-    end
-
-    def valid?(context = nil)
-      errors.blank?
-    end
-
-    def invalid?
-      !valid?
-    end
-
-    def assign_attributes(attributes = {})
-      return if attributes.blank?
-
-      attributes.each do |name, value|
-        send("#{name}=", value)
-      end
-    end
-
-    def safe_table_hash
-      safe_hash = table_hash.dup
-
-      if self.class.save_attr_white_list.present?
-        safe_hash.slice!(*self.class.save_attr_white_list)
-      else
-        self.class.save_attr_black_list.each { |attribute| safe_hash.delete(attribute) }
-      end
-
-      safe_hash
-    end
-
-    private ######################### PRIVATE ###############################
-
-    def get_nested_object_variable(nested_object_symbol, nested_object_class_or_options)
-      nested_object_variable = instance_variable_get("@#{nested_object_symbol}")
-
-      return nested_object_variable if nested_object_variable.present?
-
-      nested_object_variable = initialize_nested_object_variable(table_hash[nested_object_symbol], nested_object_class_or_options, nested_object_symbol)
-
-      instance_variable_set("@#{nested_object_symbol}", nested_object_variable)
-
-      nested_object_variable
-    end
-
-    def initialize_nested_object_variable(attributes, nested_object_class_or_options, nested_object_symbol)
-      if attributes.kind_of?(Array)
-        get_nested_objects(attributes, nested_object_class_or_options, nested_object_symbol)
-      else
-        get_nested_object(attributes, nested_object_class_or_options, nested_object_symbol)
-      end
-    end
-
-    def get_nested_objects(nested_objects_attributes, nested_object_class_or_options, nested_object_symbol)
-      nested_objects = nested_objects_attributes.map { |attributes| get_nested_object(attributes, nested_object_class_or_options, nested_object_symbol) }
-
-      if nested_object_class_or_options.kind_of?(Hash)
-        nested_objects = order_by(nested_objects, nested_object_class_or_options[:order_by], nested_object_class_or_options[:order])
-      end
-
-      nested_objects
-    end
-
-    def get_nested_object(nested_objects_attributes, nested_object_class_or_options, nested_object_symbol)
-      return (plural?(nested_object_symbol) ? [] : nil) if nested_objects_attributes.blank?
-      
-      return get_nested_object_according_to_options(nested_objects_attributes, nested_object_class_or_options, nested_object_symbol) if nested_object_class_or_options.kind_of?(Hash)
-
-      nested_object_class_or_options.new(nested_objects_attributes)
-    end
-
-    def get_nested_object_according_to_options(nested_objects_attributes, options, nested_object_symbol)
-      nested_objects_attributes = options[:parser].call(nested_objects_attributes) if options[:parser].present?
-
-      begin
-        options[:class].new(nested_objects_attributes)
-      rescue
-        options[:default].present? ? options[:default] : nested_objects_attributes
-      end
-    end
-
-    def plural?(string)
-      string = string.to_s
-      string == string.pluralize
-    end
-
-    def order_by(list, method, order)
-      return list if method.blank? || order.blank?
-
-      if order == :asc
-        list.sort { |a, b| a.send(method) <=> b.send(method) }
-      elsif order == :desc
-        list.sort { |a, b| b.send(method) <=> a.send(method) }
-      end
-    end
-
-
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    module ClassMethods
-      
-      def nested_objects_classes(hash)
-        hash.each do |nested_object_symbol, nested_object_class_or_options|
-          define_method(nested_object_symbol.to_s) do
-            get_nested_object_variable(nested_object_symbol, nested_object_class_or_options)
-          end
-        end
-      end
-
-      attr_writer :endpoint
-      def endpoint
-        if defined?(@endpoint)
-          @endpoint
-        else
-          @endpoint = superclass_responds_to?(:endpoint) ? superclass.endpoint : ENV["API_ENDPOINT"]
-        end
-      end
-
-      attr_writer :endpoint_user
-      def endpoint_user
-        if defined?(@endpoint_user)
-          @endpoint_user
-        else
-          @endpoint_user = superclass_responds_to?(:endpoint_user) ? superclass.endpoint_user : ENV["API_USER"]
-        end
-      end
-
-      attr_writer :endpoint_pass
-      def endpoint_pass
-        if defined?(@endpoint_pass)
-          @endpoint_pass
-        else
-          @endpoint_pass = superclass_responds_to?(:endpoint_pass) ? superclass.endpoint_pass : ENV["API_PASS"]
-        end
-      end
-
-      attr_writer :save_attr_black_list
-      def save_attr_black_list
-        @save_attr_black_list ||= [:id, :created_at, :updated_at, :errors]
-      end
-
-      attr_writer :save_attr_white_list
-      def save_attr_white_list
-        @save_attr_white_list ||= []
-      end
-
-      attr_writer :model_name
-      def model_name
-        @model_name ||= name.split('::').last.underscore.capitalize
-      end
-
-      def model_name_downcase
-        model_name.downcase
-      end
-
-      attr_writer :table_name
-      def table_name
-        @table_name ||= model_name_downcase.to_s.pluralize
-      end
-
-      def human_attribute_name(attribute_key_name, options = {})
-        defaults = []
-        defaults << "smooth_operator.attributes.#{name.underscore}.#{attribute_key_name}"
-        defaults << "activerecord.attributes.#{name.underscore}.#{attribute_key_name}".to_sym
-        defaults << options[:default] if options[:default]
-        defaults.flatten!
-        defaults << attribute_key_name.to_s.humanize
-        options[:count] ||= 1
-        I18n.translate(defaults.shift, options.merge(default: defaults))
-      end
-
-      private ################################ PRIVATE #########################
-
-      def superclass_responds_to?(method_name)
-        superclass.name.split('::')[0] != 'SmoothOperator' && superclass.respond_to?(method_name)
-      end
-
-      def build_url(relative_path)
-        slash = '/' if relative_path.present?
-        extention = '.json'
-        [endpoint, table_name, slash, relative_path.to_s, extention].join
-      end
-
-      def get_basic_auth_credentials
-        if endpoint_user.present? || endpoint_pass.present?
-          { username: endpoint_user, password: endpoint_pass }
-        else
-          nil
-        end
-      end
-
-    end
-    
-  end
-end