naranya_ecm-sdk 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb455d97321126300a191b589db3204014254115
-  data.tar.gz: 912aa46d7321a71136aa42568927e0749715a955
+  metadata.gz: 32f1bd7a2e3f7b53d53c6468361ed0e9a1dd3f7a
+  data.tar.gz: 7b073faaa781f9d97fe1b7992d45980696973a9a
 SHA512:
-  metadata.gz: 1c2b38a2edaa91ee6782e19843eba65f3809014c176daa18f495058f2210894277300f6ab9e7aacd98c1781a4e2fa616a84242dfc209084b09ee4bfcb5d0a20a
-  data.tar.gz: a4f1363812dc63eceb161577aa450a6dcef942a1badb92043790a24c28bc4a5715920b87398f4bf83d78c3bf7b1475effbfb631e52667d5cae38f6f4549fa673
+  metadata.gz: 83ac78eb692f78afe2af0edaacbf78c5af3aff392170d4f8a11ff1759509ef3881434c5d5661aa1bdea22e9a1a01b28921d34b02e04af8441bc87c60fdcf8d56
+  data.tar.gz: f4fc65d122c667b529ee78c5b961ecab1a478f8c4bdda01f1c1bc0405614bfbb0752844d906b96f90511e8b488516a2fffec28203fbcfc748ec62b1e380454b3

data/README.rdoc

@@ -0,0 +1,28 @@
+= NaranyaEcm
+
+TODO: Write a gem description
+
+== Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'naranya_ecm-sdk'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install naranya_ecm
+
+== Development: Running on console:
+    
+    $ bundle console
+
+== Usage
+
+TODO: Write usage instructions here
+
+== Contributing
+

data/lib/naranya_ecm-sdk.rb

@@ -20,6 +20,7 @@ module NaranyaEcm
   module Rest
     extend ActiveSupport::Autoload
     autoload :Client
+    autoload :Errors
     autoload :Persistence
     autoload :Associations
     autoload :Model
@@ -58,6 +59,7 @@ module NaranyaEcm
 
   DEFAULT_CONFIG = {
     site: "http://ecm.naranya.net:5000",
+    cache_store: []
   }.freeze
 
   class << self
@@ -79,6 +81,11 @@ module NaranyaEcm
       config
     end
 
+    def cache
+      auto_conf unless config.present?
+      @cache ||= ActiveSupport::Cache.lookup_store *options[:cache]
+    end
+
     def load_config_from_yml(yml_path, env="production")
       raise "YAML file doesn't extst" unless File.exist?(yml_path)
       yml_config = DEFAULT_CONFIG.merge(YAML::load(ERB.new(File.read(yml_path)).result)[env])
@@ -93,6 +100,9 @@ module NaranyaEcm
       if defined?(Rails)
         yml_path = File.join(Rails.root, 'config', 'naranya_ecm.yml')
         load_config_from_yml(yml_path, Rails.env)
+
+        # Use the Rails cache:
+        @cache = Rails.cache
       elsif File.exists?('./naranya_ecm.yml')
         load_config_from_yml('./naranya_ecm.yml')
       end

data/lib/naranya_ecm-sdk/version.rb

@@ -1,3 +1,3 @@
 module NaranyaEcm
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

data/lib/naranya_ecm/rest/client.rb

@@ -1,4 +1,60 @@
+require 'httparty'
+require 'naranya_ecm/rest/errors'
+require 'active_support/core_ext/hash/indifferent_access.rb'
+
 module NaranyaEcm::Rest
   class Client
+
+    TOKEN_CACHE_KEY = 'naranya_ecm/client/client_token'
+
+    class << self
+
+      %w(get post put patch delete).map(&:to_sym).each do |method_symbol|
+        define_method method_symbol do |path, options = {}|
+          execute_request method_symbol, path, options
+        end
+      end
+
+      private
+
+        def execute_request(method, path, options = {})
+          url = "#{NaranyaEcm.options[:site]}#{path}"
+
+          options[:headers] = {} unless options.has_key? :headers
+          options[:headers]['Authorization'] = authorization_header
+          
+          response = HTTParty.send method, url, options
+
+          # Retry if response code is 422 and a client token is present:
+          if response.code == 401 && authorization_header.present?
+            options[:headers]['Authorization'] = authorization_header(true)
+            response = HTTParty.send method, url, options
+          end
+          ::NaranyaEcm::Rest::RestError.raise_by_code(response.code) unless response.success?
+          
+          response
+        end
+
+        # https://github.com/applicake/doorkeeper/wiki/Client-Credentials-flow
+        def authorization_header(clear = false)
+          
+          if clear
+            @authorization_header = nil
+            NaranyaEcm.cache.delete TOKEN_CACHE_KEY
+          end
+
+          @authorization_header ||= NaranyaEcm.cache.fetch(TOKEN_CACHE_KEY) do
+            token_response = HTTParty.post "#{NaranyaEcm.options[:site]}/oauth/token",
+              basic_auth: { username: NaranyaEcm.options[:api_key], password: NaranyaEcm.options[:api_secret] },
+              body: { grant_type: "client_credentials" }
+
+            ::NaranyaEcm::Rest::RestError.raise_by_code(token_response.code) unless token_response.success?
+            
+            "Bearer #{token_response['access_token']}"
+          end
+        end
+
+    end
+
   end
 end

data/lib/naranya_ecm/rest/errors.rb

@@ -3,6 +3,18 @@ module NaranyaEcm::Rest
   #
   # Generic REST exception class.
   class RestError < StandardError
+
+    def self.raise_by_code(code, message = "")
+      klass = case code
+      when 401 then AuthorizationRequired
+      when 403 then Forbidden
+      when 404 then ResourceNotFound
+      when 422 then UnprocessableEntity
+      else RemoteFailed
+      end
+      raise klass, "Server responded with code #{code}. Message: #{message}"
+    end
+
   end
 
   # Raised when an object assigned to an association has an incorrect type.
@@ -35,19 +47,22 @@ module NaranyaEcm::Rest
 
   # Raised when connection to the database could not been established (for example when <tt>connection=</tt>
   # is given a nil object).
-  class ConnectionNotEstablished < RestError
-  end
+  class ConnectionNotEstablished < RestError; end
 
   # Raised when REST cannot find record by given id or set of ids.
-  class ResourceNotFound < RestError
-  end
+  class ResourceNotFound < RestError; end
 
   # Raised by ActiveRecord::Base.save! and ActiveRecord::Base.create! methods when record cannot be
   # saved because record is invalid.
-  class ResourceNotSaved < RestError
-  end
+  class ResourceNotSaved < RestError; end
 
   # Raised by ActiveRecord::Base.destroy! when a call to destroy would return false.
-  class ResourceNotDestroyed < RestError
-  end
+  class ResourceNotDestroyed < RestError; end
+
+  class AuthorizationRequired < RestError; end
+
+  class Forbidden < RestError; end
+  class UnprocessableEntity < RestError; end
+  class RemoteFailed < RestError; end
+
 end

data/lib/naranya_ecm/rest/finder_methods.rb

@@ -1,4 +1,6 @@
 require 'naranya_ecm/rest/errors'
+require 'naranya_ecm/rest/client'
+
 module NaranyaEcm::Rest
 
   module FinderMethods
@@ -22,15 +24,7 @@ module NaranyaEcm::Rest
 
       def fetch_one(id)
         format = NaranyaEcm.options[:format] || 'json'
-
-        response = self.get("#{path}/#{id}.#{format}")
-
-        case response.code
-        when 404
-          raise ResourceNotFound
-        when 200
-          response.to_hash
-        end
+        Client.get("#{path}/#{id}.#{format}").to_hash
       end
   end
 end

data/lib/naranya_ecm/rest/model.rb

@@ -62,10 +62,6 @@ module NaranyaEcm::Rest
       # Ignore the server resource's url attribute:
       attr_accessor :url
 
-      include HTTParty
-      base_uri NaranyaEcm.options[:site]
-      #debug_output $stderr
-
       include NaranyaEcm::Rest::Associations
       include NaranyaEcm::Rest::Persistence
 

data/lib/naranya_ecm/rest/persistence.rb

@@ -5,7 +5,7 @@ module NaranyaEcm::Rest
     extend ActiveSupport::Concern
 
     included do
-      define_model_callbacks :create, :update, :save
+      define_model_callbacks :create, :update, :save, :destroy
     end
 
     def save
@@ -17,6 +17,16 @@ module NaranyaEcm::Rest
       end
     end
 
+    def destroy
+      run_callbacks :destroy do
+        #raise ReadOnlyRecord if readonly?
+        #destroy_associations
+        self.class.delete(self.id) if persisted?
+        @destroyed = true
+        freeze
+      end
+    end
+
     def new_resource?; self.id.nil?; end
     alias_method :new?, :new_resource?
 
@@ -39,15 +49,10 @@ module NaranyaEcm::Rest
 
       def reload
         format = NaranyaEcm.options[:format] || 'json'
-        get_path = "#{path}.#{format}"
-        response = self.class.get get_path
-        case response.code
-        when 200
-          load(response.to_hash)
-          true
-        else
-          false
-        end
+        response = Client.get "#{path}.#{format}"
+        
+        load(response.to_hash)
+        true
       end
 
       def reload!; raise "Ja!" unless reload; end
@@ -65,13 +70,11 @@ module NaranyaEcm::Rest
           format = NaranyaEcm.options[:format] || 'json'
           create_path = "#{self.class.path}.#{format}"
 
-          response = self.class.post create_path, persist_request_options(self.attributes)
-          
-          case response.code
-          when 201
+          begin
+            response = Client.post create_path, persist_request_options(self.attributes)
             self.load(response.to_hash)
             true
-          when 422 # Unprocessable Entity
+          rescue UnprocessableEntity
             self.load_server_errors(response.to_hash)
             false
           end
@@ -90,13 +93,12 @@ module NaranyaEcm::Rest
           format = NaranyaEcm.options[:format] || 'json'
           update_path = "#{self.path}.#{format}"
 
-          response = self.class.put update_path, persist_request_options(attributes_to_save)
-          case response.code
-          when 204
+          begin
+            response = Client.put update_path, persist_request_options(attributes_to_save)
             self.reload!
             off_band_changes.clear if off_band_changes.present?
             true
-          when 422 # Unprocessable Entity
+          rescue UnprocessableEntity
             self.load_server_errors(response.to_hash)
             false
           end
@@ -119,13 +121,8 @@ module NaranyaEcm::Rest
       end
 
       def delete(id, options={})
-        response = HTTParty.delete("#{NaranyaEcm.options[:site]}#{self.path}/#{id}.json")
-        case response.code
-        when 204
-          true
-        else
-          false
-        end
+        response = Client.delete("#{self.path}/#{id}.json")
+        true
       end
 
     end

data/lib/naranya_ecm/rest/relation.rb

@@ -1,3 +1,6 @@
+require 'naranya_ecm/rest/errors'
+require 'naranya_ecm/rest/client'
+
 module NaranyaEcm::Rest
   class Relation
     include Enumerable
@@ -24,13 +27,7 @@ module NaranyaEcm::Rest
 
     def fetch_from_server
       format = NaranyaEcm.options[:format] || 'json'
-      response = klass.get("#{klass.path}.#{format}", query: conditions)
-      case response.code
-      when 404
-        raise ResourceNotFound
-      when 200
-        response.to_a
-      end
+      Client.get("#{klass.path}.#{format}", query: conditions).to_a
     end
 
     def load(given_list)

data/lib/naranya_ecm/search/results.rb

@@ -1,11 +1,9 @@
 require 'naranya_ecm/rest/relation'
+require 'naranya_ecm/rest/client'
 
 module NaranyaEcm::Search
   class Results < NaranyaEcm::Rest::Relation
 
-    include HTTParty
-    base_uri NaranyaEcm.options[:site]
-
     DEFAULT_MATERIALIZER = Proc.new do |search_results|
     
       # Duplicate the hits array - we'll replace each element with the
@@ -106,13 +104,10 @@ module NaranyaEcm::Search
         search_path = klass.present? ? klass.path : ''
         search_path += '/_search'
 
-        # Use the class connection to get the search results,
-        # using any authentication / headers configured:
-        #search_response = connection.get(search_path, headers)
         search_body = ActiveSupport::JSON.encode(conditions)
-        search_response = self.class.get search_path, body: search_body
+        search_response = NaranyaEcm::Rest::Client.get search_path, body: search_body
         
-        puts "curl -XGET '#{NaranyaEcm.options[:site]}#{search_path}?pretty=true' -d '#{search_body}'"
+        # puts "curl -XGET '#{NaranyaEcm.options[:site]}#{search_path}?pretty=true' -d '#{search_body}'"
         
         # Parse the search results:
         @facts = search_response.to_hash.with_indifferent_access

metadata

@@ -1,153 +1,153 @@
 --- !ruby/object:Gem::Specification
 name: naranya_ecm-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Roberto Quintanilla
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-03 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.4
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.4
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 4.0.4
 - !ruby/object:Gem::Dependency
   name: httparty
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: state_machine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: fog
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.5'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta2
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 3.0.0.beta2
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.16'
 description: Cliente Ruby de NaranyaEcm
@@ -157,10 +157,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
+- ".gitignore"
 - Gemfile
 - LICENSE.txt
-- README.md
+- README.rdoc
 - Rakefile
 - dev/create_cvm.rb
 - dev/init.rb
@@ -207,17 +207,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.0.14
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Cliente Ruby de NaranyaEcm

data/README.md

@@ -1,33 +0,0 @@
-# NaranyaEcm
-
-TODO: Write a gem description
-
-## Installation
-
-Add this line to your application's Gemfile:
-
-    gem 'naranya_ecm'
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install naranya_ecm
-
-## Development: Running on console:
-    
-    $ bundle console
-
-## Usage
-
-TODO: Write usage instructions here
-
-## Contributing
-
-1. Fork it ( http://github.com/<my-github-username>/naranya_ecm/fork )
-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