smooth_operator 0.0.2

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+.DS_Store

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in smooth_operator.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 goncalvesjoao
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,29 @@
+# SmoothOperator
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'smooth_operator'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install smooth_operator
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/smooth_operator.rb

@@ -0,0 +1,6 @@
+module SmoothOperator
+  # Thank you Mario! But our princess is in another castle!
+end
+
+require "smooth_operator/version"
+require "smooth_operator/base"

data/lib/smooth_operator/base.rb

@@ -0,0 +1,62 @@
+require "smooth_operator/operator"
+require "smooth_operator/orm"
+
+module SmoothOperator
+  class Base < OpenStruct
+
+    include SmoothOperator::Operator
+    include SmoothOperator::ORM
+
+    def hash_of_full_content
+      @table
+    end
+
+    def as_json(options = nil)
+	    @table.as_json(options)
+	  end
+
+    def self.nested_objects_classes(hash)
+      hash.each do |nested_object_symbol, nested_object_class|
+        define_method(nested_object_symbol.to_s) do
+          get_nested_object_variable(nested_object_symbol, nested_object_class)
+        end
+      end
+    end
+
+    private #---------------------------- private
+
+    def get_nested_object_variable(nested_object_symbol, nested_object_class)
+      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(hash_of_full_content[nested_object_symbol], nested_object_class, 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, nested_object_symbol)
+      if attributes.kind_of? Array
+        attributes.map { |_attributes| get_nested_object(_attributes, nested_object_class, nested_object_symbol) }
+      else
+        get_nested_object(attributes, nested_object_class, nested_object_symbol)
+      end
+    end
+
+    def get_nested_object(nested_objects_attributes, nested_object_class, nested_object_symbol)
+      if nested_objects_attributes.blank?
+        plural?(nested_object_symbol) ? [] : nil
+      else
+        nested_object_class.new(nested_objects_attributes)
+      end
+    end
+
+    def plural?(string)
+      string = string.to_s
+      string == string.pluralize
+    end
+
+  end
+end

data/lib/smooth_operator/exceptions.rb

@@ -0,0 +1,60 @@
+module SmoothOperator
+	module Exceptions
+
+  	extend self
+
+  	def raise_proper_exception(response)
+  		return nil if CODES_TO_IGNORE.include?(response.code)
+  		exception_to_raise = (CODE_VS_EXCEPTIONS[response.code] || SmoothOperator::Exceptions::Unknown).new(response)
+  		raise exception_to_raise, exception_to_raise.message
+  	end
+
+		class Base < StandardError
+			attr_reader :response
+
+	  	def initialize(response)
+		    @response = response
+		  end
+		end
+
+		class Unknown < SmoothOperator::Exceptions::Base
+			def message
+	  		'Unknown Error'
+	  	end
+		end
+
+  	class	NotFound < SmoothOperator::Exceptions::Base
+  		def message
+	  		'NotFound'
+	  	end
+  	end
+
+  	class	EntityNotProcessed < SmoothOperator::Exceptions::Base
+  		def message
+	  		'EntityNotProcessed'
+	  	end
+  	end
+
+  	class	ServerError < SmoothOperator::Exceptions::Base
+  		def message
+	  		'ServerError'
+	  	end
+  	end
+  	
+  	class	AuthorizationRequired < SmoothOperator::Exceptions::Base
+  		def message
+	  		'AuthorizationRequired'
+	  	end
+  	end
+
+		CODES_TO_IGNORE = [200]
+
+  	CODE_VS_EXCEPTIONS = {
+  		401 => AuthorizationRequired,
+  		422 => EntityNotProcessed,
+  	 	404 => NotFound,
+  	 	500 => ServerError
+  	}
+
+	end
+end

data/lib/smooth_operator/open_struct.rb

@@ -0,0 +1,16 @@
+module SmoothOperator
+  module OpenStruct
+
+    extend self # extends the module Class with its instance methods and
+                # makes it possible do 'SmoothOperator::OpenStruct.new'
+
+    def new(attributes = {})
+      ::OpenStruct.new(attributes).extend(SmoothOperator::OpenStruct)
+    end
+
+    def to_hash
+      @table
+    end
+
+  end
+end

data/lib/smooth_operator/operator.rb

@@ -0,0 +1,100 @@
+require "smooth_operator/protocol_handler"
+
+module SmoothOperator
+  module Operator
+
+    HTTP_SUCCESS_CODES = [200, 201, 202, 203, 204]
+
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+
+      attr_writer :endpoint
+      def endpoint
+        @endpoint ||= ENV["API_ENDPOINT"]
+      end
+
+      attr_writer :endpoint_user
+      def endpoint_user
+        @endpoint_user ||= ENV["API_USER"]
+      end
+
+      attr_writer :endpoint_pass
+      def endpoint_pass
+        @endpoint_pass ||= ENV["API_PASS"]
+      end
+
+      def get(relative_path, options = {})
+        make_the_call(:get, relative_path, SmoothOperator::ProtocolHandler.get_options(options))
+      end
+
+      def post(relative_path, options = {})
+        make_the_call(:post, relative_path, SmoothOperator::ProtocolHandler.post_options(options))
+      end
+
+      def put(relative_path, options = {})
+        make_the_call(:put, relative_path, SmoothOperator::ProtocolHandler.put_options(options))
+      end
+
+      def delete(relative_path, options = {})
+        make_the_call(:delete, relative_path, SmoothOperator::ProtocolHandler.delete_options(options))
+      end
+
+
+      def safe_get(relative_path, options = {})
+        safe_response(get(relative_path, options)) rescue nil
+      end
+
+      def safe_post(relative_path, options = {})
+        safe_response(post(relative_path, options)) rescue nil
+      end
+
+      def safe_put(relative_path, options = {})
+        safe_response(put(relative_path, options)) rescue nil
+      end
+
+      def safe_delete(relative_path, options = {})
+        safe_response(delete(relative_path, options)) rescue nil
+      end
+
+      def safe_response(response)
+        successful_response?(response) ? response.parsed_response : nil
+      end
+      
+
+      def make_the_call(http_verb, relative_path, options = {})
+        url = build_url(relative_path)
+        options = build_options(options)
+        response = SmoothOperator::ProtocolHandler.send(http_verb, url, options)
+        response
+      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 set_basic_auth_credentials(options)
+        if endpoint_user.present? || endpoint_pass.present? && !options.include?(:basic_auth)
+          options.merge({ basic_auth: { username: endpoint_user, password: endpoint_pass } })
+        else
+          options
+        end
+      end
+
+      def build_options(options)
+        options = {} if options.blank?
+        set_basic_auth_credentials(options)
+      end
+
+      def successful_response?(response)
+        HTTP_SUCCESS_CODES.include?(response.code) || response.blank?
+      end
+
+    end
+
+  end
+end

data/lib/smooth_operator/orm.rb

@@ -0,0 +1,154 @@
+require "smooth_operator/exceptions"
+
+module SmoothOperator
+  module ORM
+
+    def self.included(base)
+      base.extend(ClassMethods)
+      base.send(:attr_reader, :last_response)
+    end
+
+    module ClassMethods
+
+      attr_writer :save_attr_black_list
+      def save_attr_black_list
+        @save_attr_black_list ||= [:id, :created_at, :updated_at]
+      end
+
+      attr_writer :save_attr_white_list
+      def save_attr_white_list
+        @save_attr_white_list ||= []
+      end
+
+      def find(id, options = {})
+        if id == :all
+          find_each(options)
+        else
+          find_one(id, options)
+        end
+      end
+
+      def safe_find(id, options = {})
+        begin
+          find(id, options)
+        rescue Exception => exception #exception.response contains the server response
+          id == :all ? [] : nil
+        end
+      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
+
+      private #------------------------------------------------ private
+
+      def instantiate_each(objects)
+        objects.map { |object| new(object) }
+      end
+
+      def find_each(options)
+        response = get(nil, options)
+        parsed_response = parse_response_or_raise_proper_exception(response)
+        parsed_response.kind_of?(Array) ? instantiate_each(parsed_response) : parsed_response
+      end
+
+      def find_one(id, options)
+        response = get(id, options)
+        parsed_response = parse_response_or_raise_proper_exception(response)
+        new(parsed_response)
+      end
+
+      def parse_response_or_raise_proper_exception(response)
+        if successful_response?(response)
+          response.parsed_response
+        else
+          SmoothOperator::Exceptions.raise_proper_exception(response)
+        end
+      end
+
+    end
+
+    def save
+      begin
+        save!
+      rescue Exception => exception
+        false
+      end
+    end
+
+    def save!
+      @last_response = create_or_update
+      import_response_errors(@last_response)
+      SmoothOperator::Exceptions.raise_proper_exception(@last_response) unless self.class.successful_response?(@last_response)
+      true
+    end
+
+    def destroy
+      return true if new_record?
+      
+      @last_response = self.class.delete(self.id)
+      import_response_errors(@last_response)
+      self.class.successful_response?(@last_response)
+    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?
+      errors.blank?
+    end
+
+    def invalid?
+      !valid?
+    end
+
+    def hash_of_safe_content
+      safe_hash = hash_of_full_content.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 create_or_update
+      if new_record?
+        self.class.post('', { self.class.model_name_downcase => hash_of_safe_content })
+      else
+        self.class.put(self.id, { self.class.model_name_downcase => hash_of_safe_content })
+      end
+    end
+
+    def import_response_errors(response)
+      if response.present? && response.parsed_response.include?('errors')
+        self.errors = response.parsed_response['errors']
+      end
+    end
+
+  end
+end

data/lib/smooth_operator/protocol_handler.rb

@@ -0,0 +1,26 @@
+require 'httparty'
+
+module SmoothOperator
+  class ProtocolHandler
+  
+    include ::HTTParty
+    format :json
+
+    def self.get_options(options)
+    	{ query: options }
+    end
+
+    def self.post_options(options)
+    	{ body: options }
+    end
+
+    def self.put_options(options)
+    	{ body: options }
+    end
+
+    def self.delete_options(options)
+    	{ body: options }
+    end
+    
+  end
+end

data/lib/smooth_operator/version.rb

@@ -0,0 +1,3 @@
+module SmoothOperator
+  VERSION = "0.0.2"
+end

data/smooth_operator.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'smooth_operator/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "smooth_operator"
+  spec.version       = SmoothOperator::VERSION
+  spec.authors       = ["João Gonçalves"]
+  spec.email         = ["goncalves.joao@gmail.com"]
+  spec.description   = %q{ActiveResource alternative}
+  spec.summary       = %q{Simple and fully customizable alternative to ActiveResource, based on httparty gem}
+  spec.homepage      = "https://github.com/goncalvesjoao/smooth_operator"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+
+  spec.add_dependency(%q<httparty>, [">= 0.11.0"])
+end

metadata

@@ -0,0 +1,110 @@
+--- !ruby/object:Gem::Specification
+name: smooth_operator
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- João Gonçalves
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.11.0
+description: ActiveResource alternative
+email:
+- goncalves.joao@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/smooth_operator.rb
+- lib/smooth_operator/base.rb
+- lib/smooth_operator/exceptions.rb
+- lib/smooth_operator/open_struct.rb
+- lib/smooth_operator/operator.rb
+- lib/smooth_operator/orm.rb
+- lib/smooth_operator/protocol_handler.rb
+- lib/smooth_operator/version.rb
+- smooth_operator.gemspec
+homepage: https://github.com/goncalvesjoao/smooth_operator
+licenses:
+- MIT
+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
+signing_key: 
+specification_version: 3
+summary: Simple and fully customizable alternative to ActiveResource, based on httparty
+  gem
+test_files: []
+has_rdoc: