api-resource 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e5dae0339d240421eb712387cb2a22f95da96640
-  data.tar.gz: ec15e6fe4b2179873490059e11ca1811823ddee1
+  metadata.gz: b9705d238f913f0554c790cfe2958570fac35ba1
+  data.tar.gz: f6038bdafafd1544a5a49bd633ba87e5ff01b9c0
 SHA512:
-  metadata.gz: 1be26aca4ea7a90274e8ebe02dec7c3c18bcc51df974dfee5c3e9f471464cf490e5e68405e6cfd55155e18055d23c01cd7b458e8341aed78235476b005822b96
-  data.tar.gz: e5daac829ddb90523e31364302d53eec67046474c2ae8915921245828b0c6a50079e61fcaf2a2a9d1c38f3bc0c950792139f4b593667f1f39ad26e1b25832069
+  metadata.gz: ec9cd10d4e3e5bc87931e9b9b69bf15f5ca266a706cf21128e5f2e9678ee119c8d82cee0d284d711a0ec457af0a3f2ab041897a584a61c9b3306e6e0c9d53a36
+  data.tar.gz: 4641956e83fcb957bb54319afb7229792eaa863aad170e6b53e23e5969f965fc782c9677cd7509b13a05d093537cc2a1ac26bcd3bf8a9101e9a69e3117c75804

data/lib/api-resource/resource.rb

@@ -5,109 +5,111 @@ require 'active_model/serializers/json'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'active_support/core_ext/object/to_param'
 
-class Resource
-
-  include ActiveModel::Model
-  include ActiveModel::Serializers::JSON
-
-  class_attribute :base_url
-  class_attribute :hmac
-  class_attribute :api_id
-  class_attribute :api_secret
-  class_attribute :auth_prefix
-
-  def self.with_hmac(api_id, api_secret, auth_prefix='APIAuth')
-    self.hmac        = true
-    self.api_id      = api_id
-    self.api_secret  = api_secret
-    self.auth_prefix = auth_prefix
-  end
-
-  def initialize(hash=nil)
-    self.attributes = hash if hash
-  end
+module ApiResource
+  class Resource
+
+    include ActiveModel::Model
+    include ActiveModel::Serializers::JSON
+
+    class_attribute :base_url
+    class_attribute :hmac
+    class_attribute :api_id
+    class_attribute :api_secret
+    class_attribute :hmac_options
+
+    def self.with_hmac(api_id, api_secret, options={})
+      self.hmac         = true
+      self.api_id       = api_id
+      self.api_secret   = api_secret
+      self.hmac_options = options
+    end
 
-  def self.resource_name
-    self.to_s.tableize
-  end
+    def initialize(hash=nil)
+      self.attributes = hash if hash
+    end
 
-  def self.find(id)
-    result = client(:get, {}, resource_name, id)
-    self.new.from_json(result)
-  end
+    def self.resource_name
+      self.to_s.tableize
+    end
 
-  def self.all
-    result = client(:get, {}, resource_name)
-    array  = JSON.parse(result)
-    array.map { |h| self.new(h) }
-  end
+    def self.find(id)
+      result = client(:get, {}, resource_name, id)
+      self.new.from_json(result)
+    end
 
-  def self.where(options, verb=:get)
-    result = client(verb, *(verb==:get ? [{}, "#{resource_name}?#{options.to_param}"] : [options, resource_name]))
-    array = JSON.parse(result)
-    array.map { |h| self.new(h) }
-  end
+    def self.all
+      result = client(:get, {}, resource_name)
+      array  = JSON.parse(result)
+      array.map { |h| self.new(h) }
+    end
 
-  def attributes
-    instance_values.with_indifferent_access
-  end
+    def self.where(options, verb=:get)
+      result = client(verb, *(verb==:get ? [{}, "#{resource_name}?#{options.to_param}"] : [options, resource_name]))
+      array  = JSON.parse(result)
+      array.map { |h| self.new(h) }
+    end
 
-  protected
+    def attributes
+      instance_values.with_indifferent_access
+    end
 
-  def attributes=(hash)
-    hash.each do |key, value|
-      if respond_to? "#{key}="
-        send("#{key}=", value)
-      else
-        child_class = self.class.load_class(key)
-        if child_class && child_class < Resource
-          if value.is_a?(Hash)
-            child_value = child_class.new(value)
-            define_singleton_method(key) { child_value }
-          elsif value.is_a?(Array)
-            child_values = value.map { |h| child_class.new(h) }
-            define_singleton_method(key) { child_values }
+    protected
+
+    def attributes=(hash)
+      hash.each do |key, value|
+        if respond_to? "#{key}="
+          send("#{key}=", value)
+        else
+          child_class = self.class.load_class(key)
+          if child_class && child_class < Resource
+            if value.is_a?(Hash)
+              child_value = child_class.new(value)
+              define_singleton_method(key) { child_value }
+            elsif value.is_a?(Array)
+              child_values = value.map { |h| child_class.new(h) }
+              define_singleton_method(key) { child_values }
+            end
           end
         end
       end
     end
-  end
 
-  def self.method_missing(m, *args, &_)
-    unless args.empty?
-      by_method_match = /^by_(.+)/.match(m)
-      if by_method_match
-        parent_resource_name = by_method_match[1]
-        with_parent_resource(args[0], parent_resource_name)
+    def self.method_missing(m, *args, &_)
+      unless args.empty?
+        by_method_match = /^by_(.+)/.match(m)
+        if by_method_match
+          parent_resource_name = by_method_match[1]
+          with_parent_resource(args[0], parent_resource_name)
+        end
       end
     end
-  end
-
-  def self.load_class(plural_resource_name)
-    plural_resource_name.to_s.singularize.classify.constantize rescue nil
-  end
 
-  def self.with_parent_resource(parent_resource_id, parent_resource_name)
-    result = client(:get, {}, parent_resource_name.pluralize, parent_resource_id, self.resource_name)
-    hashes = JSON.parse(result)
-    hashes.map { |h| self.new(h) }
-  end
+    def self.load_class(plural_resource_name)
+      plural_resource_name.to_s.singularize.classify.constantize rescue nil
+    end
 
-  def self.client(verb, params, *paths)
-    url        = base_url
-    url        += '/' unless url.end_with?('/')
-    url        = url + paths.join('/')
-    headers    = { accept: :json }
-    req_params = { url: url, method: verb, headers: headers }
-    if verb == :get
-      headers[:params] = params
-    else
-      req_params[:payload] = params
+    def self.with_parent_resource(parent_resource_id, parent_resource_name)
+      result = client(:get, {}, parent_resource_name.pluralize, parent_resource_id, self.resource_name)
+      hashes = JSON.parse(result)
+      hashes.map { |h| self.new(h) }
     end
-    req = RestClient::Request.new(req_params)
-    if hmac
-      req.sign!(api_id, api_secret, auth_prefix)
+
+    def self.client(verb, params, *paths)
+      url        = base_url
+      url        += '/' unless url.end_with?('/')
+      url        = url + paths.join('/')
+      headers    = { accept: :json }
+      req_params = { url: url, method: verb, headers: headers }
+      if verb == :get
+        headers[:params] = params
+      else
+        req_params[:payload] = params
+      end
+      req = RestClient::Request.new(req_params)
+      if hmac
+        req.sign!(api_id, api_secret, hmac_options)
+      end
+      req.execute
     end
-    req.execute
   end
 end

data/lib/api-resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = '0.1.0'
+  VERSION = '0.2.0'
 end

data/spec/resource_spec.rb

@@ -1,6 +1,6 @@
-RSpec.describe Resource do
+RSpec.describe ApiResource::Resource do
 
-  class BlogResource < Resource
+  class BlogResource < ApiResource::Resource
     self.base_url = 'http://api.example.com'
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api-resource
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chaker Nakhli
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.0'
+        version: '0.1'
 - !ruby/object:Gem::Dependency
   name: rest-client
   requirement: !ruby/object:Gem::Requirement