has_offers 0.2.0 → 0.2.1

data/VERSION

@@ -1 +1 @@
-0.2.0
+0.2.1

data/has_offers.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{has_offers}
-  s.version = "0.2.0"
+  s.version = "0.2.1"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jkongie"]
-  s.date = %q{2010-09-27}
+  s.date = %q{2010-09-28}
   s.description = %q{This gem is a wrapper around the HasOffers API. In order to use the API, your network must be on the Enterprise pricing plan or a Dedicated solution.}
   s.email = %q{james.kong@sentia.com.au}
   s.extra_rdoc_files = [
@@ -26,6 +26,7 @@ Gem::Specification.new do |s|
      "has_offers.gemspec",
      "lib/has_offers.rb",
      "lib/has_offers/api.rb",
+     "lib/has_offers/response.rb",
      "spec/has_offers_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb"

data/lib/has_offers/api.rb

@@ -15,15 +15,23 @@ module HasOffers
 
     API_SERVICE_HOST = 'https://api.hasoffers.com/Api'
     
-    # TODO - Load Auth from a YAML file as well
-    def initialize(authentication = {})
-      @authentication = authentication
+    # Initialize a HasOffers object with the authentication values
+    # This accepts
+    #   1. A string declaring a YAML file with the correct api_key and network_id
+    #   2. A hash containing the api_key and network_id
+    #   3. By default, if left empty, it will look for config/has_offer.yml file to declare the authentication
+    def initialize(authentication = nil)
+      if authentication.nil? || authentication.is_a?(String)
+        config_file = authentication.nil? ? 'config/has_offers.yml' : authentication
+        @authentication = YAML::load(IO.read(config_file)) if File.exists?(config_file)
+      elsif authentication.is_a?(Hash)
+        @authentication = authentication
+      end
       @default_params = { 'Format' => 'json',
                           'Service' => 'HasOffers',
                           'Version' => '2',
-                          'NetworkId' => authentication[:network_id],
-                          'NetworkToken' => authentication[:api_key] }
-      
+                          'NetworkId' => @authentication['network_id'],
+                          'NetworkToken' => @authentication['api_key'] }
       self.debug_mode = false
       self.test_mode = false
     end
@@ -45,6 +53,7 @@ module HasOffers
       http = new_http uri
       raw_request = Net::HTTP::Get.new(uri.request_uri)
       http_response = http.request raw_request
+      Response.new http_response
     end
   end
   

data/lib/has_offers/response.rb

@@ -0,0 +1,69 @@
+module HasOffers
+  
+  class Response
+    
+    attr_reader :body, :http_status_code, :http_message, :http_headers
+    
+    def success?
+      @http_status_code.to_s == '200' and status == 1
+    end
+    
+    def status
+      @body['response']['status']
+    end
+    
+    # allows specific api calls to post-process the data for ease of use
+    def set_data(data)
+      @processed_data = data
+    end
+
+    def raw_data
+      @body
+    end
+
+    def data
+      @processed_data || (paginated_response? ? @body['response']['data']['data'] : @body['response']['data'])
+    end
+    
+    def page_info
+      if paginated_response?
+        {'page_count' => @body['response']['data']['pageCount'],
+         'current' => @body['response']['data']['current'],
+         'count' => @body['response']['data']['count'],
+         'page' => @body['response']['data']['page']}
+      else
+        {}
+      end
+    end
+
+    def validation_error?
+      status == -1 and data['error_code'] == 1
+    end
+
+    def error_messages
+      if data.is_a? Hash and data["errors"] and data["errors"]["error"]
+        data["errors"]["error"].map { |error| error["err_msg"] }
+      elsif @body["response"]["errors"]
+        @body["response"]["errors"].map { |error| error["err_msg"] }
+      else
+        []
+      end
+    end
+
+    def initialize(response)
+      @test = false
+      @body = JSON.parse(response.body)
+      @http_status_code = response.code
+      @http_message = response.message
+      @http_headers = response.to_hash
+    end
+    
+    protected
+
+      def paginated_response?
+        @body['response']['data'] and @body['response']['data'].is_a?(Hash) and @body['response']['data']['pageCount']
+      end
+    
+  end
+  
+end

data/lib/has_offers.rb

@@ -1,5 +1,6 @@
 %w(
 has_offers/api
+has_offers/response
 ).each do |lib|
   require File.join(File.dirname(__FILE__), lib)
 end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 0
-  version: 0.2.0
+  - 1
+  version: 0.2.1
 platform: ruby
 authors: 
 - jkongie
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-09-27 00:00:00 +10:00
+date: 2010-09-28 00:00:00 +10:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -51,6 +51,7 @@ files:
 - has_offers.gemspec
 - lib/has_offers.rb
 - lib/has_offers/api.rb
+- lib/has_offers/response.rb
 - spec/has_offers_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb