well_rested-core 0.0.4 → 0.0.5

data/lib/well_rested/api.rb

@@ -18,14 +18,10 @@ module WellRested
     attr_accessor :default_path_parameters
     attr_accessor :client
     attr_reader   :last_response
-    attr_accessor :unique_id
-    attr_accessor :version
 
-    def initialize(path_params = {}, session_params = {}, version = "")
+    def initialize(path_params = {})
       self.default_path_parameters = path_params.with_indifferent_access
       self.client = RestClient
-      self.unique_id = session_params.try(:uid) || 'unauthorized'
-      self.version = version
     end
 
     ##
@@ -101,9 +97,8 @@ module WellRested
       url = url_for(klass, path_params_or_url, query_params)
 
       logger.info "GET #{url}"
-      # response = client.get(url, request_headers) do |response, request, result, &block|
       response = client.get(url, request_headers) do |response, request, result, &block|
-      @last_response = response
+        @last_response = response
         response.return!(request, result, &block)
       end
 
@@ -244,32 +239,15 @@ module WellRested
 
     # Convenience method. Also allows request_headers to be can be set on a per-instance basis.
     def request_headers
-      self.class.request_headers(self.unique_id, self.version)
+      self.class.request_headers
     end
 
     # Return the default headers sent with all HTTP requests.
-    def self.request_headers(unique_id, version)
+    def self.request_headers
       # Accept necessary for fetching results by result ID, but not in most places.
-      {
-        :content_type => 'application/json',
-        :accept => 'application/json',
-        "Authentication" => unique_id,
-        :version => version
-      }
+      { :content_type => 'application/json', :accept => 'application/json' }
     end
 
-    # # 20120627 CR: Add authentication to header
-    # def request_headers_with_authentication(authentication_id)
-    #   self.class.request_headers_with_authentication(authentication_id)
-    # end
-
-    # # Return the default headers sent with all HTTP requests.
-    # def self.request_headers_with_authentication(authentication_id)
-    #   # Accept necessary for fetching results by result ID, but not in most places.
-    #   { :content_type => 'application/json', :accept => 'application/json', :Authentication => authentication_id}
-    # end
-
-
     # TODO: Move this into a utility module? It can then be called from Base#fill_path or directly if needed.
     def self.fill_path(path_template, params)
         raise "Cannot fill nil path" if path_template.nil?
@@ -320,7 +298,7 @@ module WellRested
       end
 
       # If ID is set in path parameters, do a PUT. Otherwise, do a POST.
-      method = resource.path_parameters[:key].blank? ? :post : :put
+      method = resource.path_parameters[:id].blank? ? :post : :put
 
       response = run_update(method, url, payload)
 
@@ -328,7 +306,7 @@ module WellRested
       decoded_hash = resource.class.attribute_formatter.decode(hash)
       logger.info "* Errors: #{decoded_hash['errors'].inspect}" if decoded_hash.include?('errors')
 
-      if response.code.between?(200,299)
+      if response.code == 200
         # If save succeeds, replace resource's attributes with the ones returned.
         return decoded_hash.map { |hash| resource.class.new_from_api(hash) } if decoded_hash.kind_of?(Array)
         resource.load_from_api(decoded_hash)

data/lib/well_rested/base.rb

@@ -29,7 +29,7 @@ module WellRested
     # class-level defaults
     self.protocol = 'http'
     # a body formatter must respond to the methods encode(hash_or_array) => string and decode(string) => hash_or_array
-    self.body_formatter = JSONFormatter.new
+    self.body_formatter = JSONFormatter.new   
     self.extension = ''
     # an attribute formatter must respond to encode(attribute_name_string) => string and decode(attribute_name_string) => string
     self.attribute_formatter = CamelCaseFormatter.new
@@ -41,11 +41,11 @@ module WellRested
     # Define the schema for this resource.
     #
     # Either takes an array, or a list of arguments which we treat as an array.
-    # Each element of the array should be either a symbol or a hash.
+    # Each element of the array should be either a symbol or a hash. 
     # If it's a symbol, we create an attribute using the symol as the name and with a null default value.
     # If it's a hash, we use the keys as attribute names.
     #   - Any values that are hashes, we use to specify further options (currently, the only option is :default).
-    #   - Any value that is not a hash is treated as a default.
+    #   - Any value that is not a hash is treated as a default. 
     #  e.g.
     #  define_schema :x, :y, :z                            # x, y, and z all default to nil
     #  define_schema :id, :name => 'John'                  # id defaults to nil, name defaults to 'John'
@@ -84,7 +84,7 @@ module WellRested
     def initialize(attrs = {})
       raise "Attrs must be hash" unless attrs.is_a? Hash
 
-      self.load(attrs, false)
+      self.load(attrs, false) 
     end
 
     # Define an actual method for ID. This is important in Ruby 1.8 where the object_id method is also aliased to id.
@@ -133,9 +133,9 @@ module WellRested
 
       #puts "*** Warning: loading a resource without a schema (#{self.class})!" if schema.nil?
       #raise "Tried to load attributes for a resource with no schema (#{self.class})!" if schema.nil?
-
+      
       # We mark a record as new if it doesn't come from the API and it doesn't have an ID.
-      self.new_record = !from_api
+      self.new_record = !from_api 
       self.new_record = false if attrs_to_load.include?(:id) or attrs_to_load.include?('id')
 
       new_attrs = {}.with_indifferent_access
@@ -192,9 +192,9 @@ module WellRested
           klass = find_resource_class(class_name)
           if klass
             #puts "**** class exists, instantiation"
-            hash[k] = v.map do |o|
-              if o.kind_of?(Hash)
-                from_api ? klass.new_from_api(o) : klass.new(o)
+            hash[k] = v.map do |o| 
+              if o.kind_of?(Hash) 
+                from_api ? klass.new_from_api(o) : klass.new(o) 
               else
                 o
               end
@@ -222,7 +222,7 @@ module WellRested
       hash
     end
 
-    # API should use these to generate the path.
+    # API should use these to generate the path. 
     # Override this to control how path variables get inserted.
     def path_parameters
       objects_to_attributes(@attributes.reject { |k,v| v.nil? }.with_indifferent_access)
@@ -237,11 +237,11 @@ module WellRested
     def to_param
       self.id.nil? ? nil : self.id.to_s
     end
-
+    
     # Return a key for rails to use for... not sure exaclty what.
     # Should be an array, or nil.
     def to_key
-      self.id.nil? ? nil : [self.id]
+      self.id.nil? ? nil : [self.id] 
     end
 
     # The following 3 methods were copied from active_record/persistence.rb

data/lib/well_rested/capi.rb

@@ -0,0 +1,87 @@
+require 'well_rested/api'
+
+module WellRested
+  # All REST requests are made through an API object.
+  # API objects store cross-resource settings such as user and password (for HTTP basic auth).
+  class CAPI < WellRested::API
+    include WellRested  # for logger
+    include WellRested::Utils
+
+    attr_accessor :user
+    attr_accessor :password
+    attr_accessor :default_path_parameters
+    attr_accessor :client
+    attr_reader   :last_response
+    attr_accessor :unique_id
+    attr_accessor :version
+
+    def initialize(path_params = {}, session_params = {}, version = "")
+      self.default_path_parameters = path_params.with_indifferent_access
+      self.client = RestClient
+      self.unique_id = session_params.try(:uid) || 'unauthorized'
+      self.version = version
+    end
+
+    # Convenience method. Also allows request_headers to be can be set on a per-instance basis.
+    def request_headers
+      self.class.request_headers(self.unique_id, self.version)
+    end
+
+    # Return the default headers sent with all HTTP requests.
+    def self.request_headers(unique_id, version)
+      # Accept necessary for fetching results by result ID, but not in most places.
+      {
+        :content_type => 'application/json',
+        :accept => 'application/json',
+        "Authentication" => unique_id,
+        :version => version
+      }
+    end
+
+
+    protected  # internal methods follow
+
+    # Create or update a resource.
+    # If an ID is set, PUT will be used, else POST.
+    # If a 200 is returned, the returned attributes will be loaded into the resource, and the resource returned.
+    # Otherwise, the resource will not be modified, and a hash generated from the JSON response will be returned.
+    def create_or_update_resource(resource, url = nil)
+      return false unless resource.valid?
+
+      #logger.info "Creating a #{resource.class}"
+
+      path_params = default_path_parameters.merge(resource.path_parameters)
+      payload_hash = resource.class.attribute_formatter.encode(resource.attributes_for_api)
+      payload = resource.class.body_formatter.encode(payload_hash)
+
+      #logger.debug " payload: #{payload.inspect}"
+
+      if url.nil?
+        url = url_for(resource.class, path_params)  # allow default URL to be overriden by url argument
+      else
+        url = url_for(resource.class, url)
+      end
+
+      # Ask the resource if it is new, then POST, otherwise PUT
+      method = resource.new? ? :post : :put
+      # If ID is set in path parameters, do a PUT. Otherwise, do a POST.
+      # method = resource.path_parameters[:key].blank? ? :post : :put
+
+      response = run_update(method, url, payload)
+
+      hash = resource.class.body_formatter.decode(response.body)
+      decoded_hash = resource.class.attribute_formatter.decode(hash)
+      logger.info "* Errors: #{decoded_hash['errors'].inspect}" if decoded_hash.include?('errors')
+
+      if response.code.between?(200,299)
+        # If save succeeds, replace resource's attributes with the ones returned.
+        return decoded_hash.map { |hash| resource.class.new_from_api(hash) } if decoded_hash.kind_of?(Array)
+        resource.load_from_api(decoded_hash)
+        return resource
+      elsif decoded_hash.include?('errors')
+        resource.handle_errors(decoded_hash['errors'])
+        return false
+      end
+    end
+  end
+end

data/lib/well_rested-core/version.rb

@@ -1,5 +1,5 @@
 module WellRested
   module Core
-    VERSION = "0.0.4"
+    VERSION = "0.0.5"
   end
 end

data/lib/well_rested-core.rb

@@ -1,25 +1,9 @@
 require "well_rested-core/version"
 
-# require "well_rested"
-
-# require 'well_rested/core_formatter'
-
-
-# # require external dependencies
-# require 'active_support/core_ext/hash/indifferent_access'
-# require 'active_support/core_ext/hash/reverse_merge'
-
-# # require internal general-use libs
-# require 'key_transformer'
-# require 'generic_utils'
-
-# # require internal libs
-require 'well_rested/api'
+# # require adapted libs
+require 'well_rested/capi'
 require 'well_rested/base'
-require 'well_rested/utils'
-# require 'well_rested/json_formatter'
 require 'well_rested/core_formatter'
-# require 'well_rested/camel_case_formatter'
 
 # Make sure 'bases' singularizes to 'base' instead of 'basis'.
 # Otherwise, we get an error that no class Basis is found in Base.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: well_rested-core
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -44,6 +44,7 @@ files:
 - lib/well_rested-core/version.rb
 - lib/well_rested/api.rb
 - lib/well_rested/base.rb
+- lib/well_rested/capi.rb
 - lib/well_rested/core_formatter.rb
 - well_rested-core.gemspec
 homepage: ''