hukd 1.1.1 → 1.1.2

data/README.md

@@ -22,12 +22,15 @@ You can start of by creating an instance of the client, which just needs an Api
     require 'hukd'
     hukd	=	Hukd.new("YOUR_API_KEY_HERE")
 
-You can then make an API request to receive a hash containing the following keys:
+You can then make an API request to receive an Array of Deal objects
 
 	deals	=	hukd.hottest('deals')
 
-	:deals					-	An array containing Deal objects
-	:total_results			-	The total number of results that can be retrieved using the current filter options
+Once you've made a successful request, the total_results attribute will become available
+
+	hukd.total_results
+
+This gives you the total number of results that can be retrieved using the current filter options
 
 The following API calls are available
 
@@ -73,13 +76,11 @@ Combining everything together will give you something like this:
     require 'hukd'
     hukd	=	Hukd.new("YOUR_API_KEY_HERE")
     deals	=	hukd.hottest('deals')
-    deals[:deals].each |deal| do
+    deals.each |deal| do
     	puts(deal.title)
     end
-    puts(deals[:total_results])
 
 This will fetch the hottest deals (default at 20) and print the title to the console.
-The total number of available results will be printed underneath
 
 Support
 --------

data/lib/hukd/base.rb

@@ -1,6 +1,6 @@
 module Hukd
 	class Base
-		attr_accessor :api_key
+		attr_accessor :api_key, :total_results
 		API_VERSION = "2.0"
 		API_BASE_URL = "http://api.hotukdeals.com/rest_api/v2/"
 
@@ -79,6 +79,10 @@ module Hukd
 		end
 
 		def get(forum='', category='', limit=20, options={})
+
+			# Reset total results
+			total_results  = 0
+
 			# Set the API_KEY
 			options['key'] = @api_key
 			options['output'] = 'json'
@@ -109,7 +113,8 @@ module Hukd
 					raise Exception, resp['error']
 				end
         # Returned parsed deals
-				return {:deals => parse_deals(resp), :total_results => resp['total_results'] }
+				total_results = resp['total_results']
+				return parse_deals(resp)
 			end
 
 		end

data/lib/hukd/version.rb

@@ -1,3 +1,3 @@
 module Hukd
-  VERSION = "1.1.1"
+  VERSION = "1.1.2"
 end

data/spec/deal_spec.rb

@@ -4,7 +4,7 @@ require "hukd"
 describe Hukd::Deal do
 
 	before(:all) do
-		@deal = Hukd.new("API_KEY_HERE").hottest('deals','',1)[:deals][0]
+		@deal = Hukd.new("API_KEY_HERE").hottest('deals','',1)[0]
 	end
 
 	it "should have a rounded temperature" do

data/spec/hukd_spec.rb

@@ -8,45 +8,45 @@ describe Hukd::Base do
 	end
 
 	it "should get hottest deals" do
-		Hukd.new("API_KEY_HERE").hottest('deals')[:deals].count.should equal(20)
+		Hukd.new("API_KEY_HERE").hottest('deals').count.should equal(20)
 	end
 
 	it "should get a custom number of deals" do
-		Hukd.new("API_KEY_HERE").hottest('deals','',10)[:deals].count.should equal(10)
+		Hukd.new("API_KEY_HERE").hottest('deals','',10).count.should equal(10)
 	end
 
 	it "shouldn't get more than 500 deals" do
-		Hukd.new("API_KEY_HERE").hottest('deals','',10000)[:deals].count.should equal(500)
+		Hukd.new("API_KEY_HERE").hottest('deals','',10000).count.should equal(500)
 	end
 
 	it "should be able to specify a forum" do
-		Hukd.new("API_KEY_HERE").hottest('vouchers','',1)[:deals][0].forum_url_name.should == "vouchers"
+		Hukd.new("API_KEY_HERE").hottest('vouchers','',1)[0].forum_url_name.should == "vouchers"
 	end
 
 	it "should be able to specify a category" do
-		Hukd.new("API_KEY_HERE").hottest('','fashion',0)[:deals][0].category_url_name.should == "fashion"
+		Hukd.new("API_KEY_HERE").hottest('','fashion',0)[0].category_url_name.should == "fashion"
 	end
 
 	it "should be able to specify a forum and category" do
-		deal  = Hukd.new("API_KEY_HERE").hottest('freebies','mobiles',1)[:deals][0]
+		deal  = Hukd.new("API_KEY_HERE").hottest('freebies','mobiles',1)[0]
 		deal.forum_url_name.should == "freebies"
 		deal.category_url_name.should == "mobiles"
 	end
 
 	it "should search by username" do
-		Hukd.new("API_KEY_HERE").user('wishihadadonkey','','',1)[:deals][0].poster_name.should ==  "wishihadadonkey"
+		Hukd.new("API_KEY_HERE").user('wishihadadonkey','','',1)[0].poster_name.should ==  "wishihadadonkey"
 	end
 
 	it "should search by tag" do
-		Hukd.new("API_KEY_HERE").tag('xbox','deals','',1)[:deals][0].tags.should include('xbox')
+		Hukd.new("API_KEY_HERE").tag('xbox','deals','',1)[0].tags.should include('xbox')
 	end
 
 	it "should search by merchant" do
-		Hukd.new("API_KEY_HERE").merchant('itunes.apple.com','','',1)[:deals][0].merchant_url_name.should ==  "itunes.apple.com"
+		Hukd.new("API_KEY_HERE").merchant('itunes.apple.com','','',1)[0].merchant_url_name.should ==  "itunes.apple.com"
 	end
 
 	it "should search by keyword" do
-		Hukd.new("API_KEY_HERE").search('xbox','deals','',false,1,1)[:deals][0].title.downcase.should include("xbox")
+		Hukd.new("API_KEY_HERE").search('xbox','deals','',false,1,1)[0].title.downcase.should include("xbox")
 	end
 
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hukd
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2012-07-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2165281240 !ruby/object:Gem::Requirement
+  requirement: &2161120580 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *2165281240
+  version_requirements: *2161120580
 - !ruby/object:Gem::Dependency
   name: httparty
-  requirement: &2165280800 !ruby/object:Gem::Requirement
+  requirement: &2161120140 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,7 +32,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2165280800
+  version_requirements: *2161120140
 description: API Wrapper for HotUKDeals (HUKD)
 email:
 - messages@cubewebsites.com