hukd 1.0.0

data/.gitignore

@@ -0,0 +1,8 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+
+.idea/*
+nbproject/*
+.project/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in hukd.gemspec
+gemspec

data/README.md

@@ -0,0 +1,90 @@
+API Client for HotUKDeals (HUKD)
+===================================
+
+This client allows you to access all the documented API features from *HUKD REST API 2.0*
+http://www.hotukdeals.com/rest-api/docs
+
+Please note that the HUKD API Documentation is not entirely upto date (for example there is no longer a clothing category) and the deals return some additional fields such as mobile_deal_link which I've attempted to include.
+You could say that the gem is actually more up to date than the API docs at the time of release :)
+
+Prerequisites
+-------------
+
+	gem install hukd
+
+YOU ARE NOW READY TO GET SOME SWEET DEAL DATA!
+
+Usage
+-----
+
+You can start of by creating an instance of the client, which just needs an Api Key.
+
+    require 'hukd'
+    hukd	=	Hukd.new("YOUR_API_KEY_HERE")
+
+You can then make an API request to receive an array of Deal objects.
+
+	deals	=	hukd.hottest('deals')
+
+The following API calls are available
+
+	hottest(forum='', category='', limit=20, options={})
+	newest(forum='', category='', limit=20, options={})
+	discussed(forum='', category='', limit=20, options={})
+	user(user='',forum='', category='', limit=20, options={})
+	tag(tag='',forum='', category='', limit=20, options={})
+	merchant(merchant='',forum='', category='', limit=20, options={})
+	online(forum='', category='', limit=20, options={})
+	offline(forum='', category='', limit=20, options={})
+	search(keywords='',forum='', category='', online=false, page=1, limit=20, exclude_expired=0)
+
+The options hash can contain all the keys available from
+http://www.hotukdeals.com/rest-api/docs
+
+Each deal object has the following attributes available:
+
+	title
+	deal_link
+	mobile_deal_link
+    deal_image
+    description
+    submit_time
+    hot_time
+    poster_name
+    temperature
+    price
+    timestamp
+    expired
+    forum_name
+    forum_url_name
+    category_name
+    category_url_name
+    merchant_name
+    merchant_url_name
+    tags (a hash containing each tag as a string)
+	deal_image_highres
+
+Combining everything together will give you something like this:
+
+    require 'hukd'
+    hukd	=	Hukd.new("YOUR_API_KEY_HERE")
+    deals	=	hukd.hottest('deals')
+    deals.each |deal| do
+    	puts(deal.title)
+    end
+
+This will fetch the hottest deals (default at 20) and print the title to the console.
+
+Support
+--------
+
+Feel free to contact me or open an issue if need be.
+
+PLEASE NOTE: You will need to add replace the "API_KEY_HERE" text with your key to make the tests pass.
+
+Thanks
+------
+
+To the [great guide](https://github.com/radar/guides/blob/master/gem-development.md) by [Hrvoje Šimić](https://github.com/shime) to help me develop my first gem :)
+
+To the [badfruit](https://github.com/brianmichel/BadFruit) gem by [brianmichel](https://github.com/brianmichel) which I referenced and to develop my own gem

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/hukd.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "hukd/version"
+
+Gem::Specification.new do |s|
+  s.name        = "hukd"
+  s.version     = Hukd::VERSION
+  s.authors     = ["Cube Websites"]
+  s.email       = ["messages@cubewebsites.com"]
+  s.homepage    = ""
+  s.summary     = "API Wrapper for HotUKDeals (HUKD)"
+  s.description = "API Wrapper for HotUKDeals (HUKD)"
+
+  s.rubyforge_project = "hukd"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec", "~> 2.6"
+	s.add_runtime_dependency "httparty"
+end

data/lib/hukd.rb

@@ -0,0 +1,11 @@
+require "hukd/version"
+require "httparty"
+
+require File.join(File.expand_path(File.dirname(__FILE__)), 'hukd', 'base')
+require File.join(File.expand_path(File.dirname(__FILE__)), 'hukd', 'deal')
+
+module Hukd
+	def self.new(apikey)
+		Hukd::Base.new(apikey);
+	end
+end

data/lib/hukd/base.rb

@@ -0,0 +1,128 @@
+module Hukd
+	class Base
+		attr_accessor :api_key
+		API_VERSION = "2.0"
+		API_BASE_URL = "http://api.hotukdeals.com/rest_api/v2/"
+
+		def initialize(key)
+			@api_key = key
+		end
+
+		def hottest(forum='', category='', limit=20, options={})
+			options['order'] = 'hot'
+			get(forum, category, limit, options)
+		end
+
+		def newest(forum='', category='', limit=20, options={})
+			options['order'] = 'new'
+			get(forum, category, limit, options)
+		end
+
+		def discussed(forum='', category='', limit=20, options={})
+			options['order'] = 'discussed'
+			get(forum, category, limit, options)
+		end
+
+		def user(user='',forum='', category='', limit=20, options={})
+			if(options['order'].nil?)
+				options['order'] = 'new'
+			end
+			options['username'] = user
+			get(forum, category, limit, options)
+		end
+
+		def tag(tag='',forum='', category='', limit=20, options={})
+			if(options['order'].nil?)
+				options['order'] = 'new'
+			end
+			options['tag'] = tag
+			get(forum, category, limit, options)
+		end
+
+		def merchant(merchant='',forum='', category='', limit=20, options={})
+			if(options['order'].nil?)
+				options['order'] = 'new'
+			end
+			options['merchant'] = merchant
+			get(forum, category, limit, options)
+		end
+
+		def online(forum='', category='', limit=20, options={})
+			if(options['order'].nil?)
+				options['order'] = 'new'
+			end
+			options['online_offline'] = 'online'
+			get(forum, category, limit, options)
+		end
+
+		def offline(forum='', category='', limit=20, options={})
+			if(options['order'].nil?)
+				options['order'] = 'new'
+			end
+			options['online_offline'] = 'offline'
+			get(forum, category, limit, options)
+		end
+
+		def search(keywords='',forum='', category='', online=false, page=1, limit=20, exclude_expired=0)
+			options = {}
+			options['search'] = keywords
+			options['page'] = page.to_int
+			options['results_per_page'] = limit.to_int
+			if(online!=false)
+				options['online_offline'] = 'online'
+			end
+
+			if(exclude_expired!=0)
+				options['exclude_expired']  = true
+			end
+			get(forum,category,limit,options)
+		end
+
+		def get(forum='', category='', limit=20, options={})
+			# Set the API_KEY
+			options['key'] = @api_key
+			options['output'] = 'json'
+
+			# Set the limit as long as it doesn't exceed the maximum allowed
+			if(limit > 500)
+				limit = 500
+			end
+			options['results_per_page'] = limit
+
+			# Specify a forum
+			if(forum != '')
+				options['forum']  = forum
+			end
+
+			# Specify a category
+			if(category != '')
+				options['category'] = category
+			end
+
+			# Make a request
+			resp  = HTTParty.get("#{API_BASE_URL}", :query => options)
+
+			# Got a success response
+			if resp.code == 200
+				deals = MultiJson.load(resp.body)
+				# Ensure a valid response is returned
+				if (deals['error'])
+					raise Exception, deals['error']
+				end
+
+				# Returned parsed deals
+				return parse_deals(deals)
+			end
+
+		end
+
+		def parse_deals(hash)
+			dealsArray = Array.new
+			hash["deals"]["items"].each do |deal|
+				dealsArray.push(Deal.new(deal, self))
+			end
+			dealsArray
+		end
+
+	end
+end

data/lib/hukd/deal.rb

@@ -0,0 +1,43 @@
+module Hukd
+	class Deal
+
+		attr_accessor  :title, :deal_link, :mobile_deal_link, :deal_image, :description, :submit_time, :hot_time, :poster_name,
+		               :temperature, :price, :timestamp, :expired,
+		               :forum_name, :forum_url_name, :category_name, :category_url_name, :merchant_name, :merchant_url_name,
+		               :tags, :deal_image_highres
+
+		def initialize(dealhash,hukd)
+			@title         = dealhash["title"]
+			@deal_link     = dealhash["deal_link"]
+			@mobile_deal_link = dealhash["mobile_deal_link"]
+			@deal_image   = dealhash["deal_image"]
+			@description   = dealhash["description"]
+			@submit_time    = dealhash["submit_time"]
+			@hot_time       =  dealhash["hot_time"]
+			@poster_name    =  dealhash["poster_name"]
+			@temperature    = dealhash["temperature"]
+			@price          = dealhash["price"]
+			@timestamp      = dealhash["timestamp"]
+			@expired        = dealhash["expired"]
+			@forum_name     = dealhash["forum"]["name"]
+			@forum_url_name = dealhash["forum"]["url_name"]
+			@category_name  = dealhash["category"]["name"]
+			@category_url_name  = dealhash["category"]["url_name"]
+			@merchant_name  = dealhash["merchant"]["name"]
+			@merchant_url_name  = dealhash["merchant"]["url_name"]
+			@tags           = parse_tags(dealhash["tags"])
+			@deal_image_highres = dealhash["deal_image_highres"]
+			@hukd = hukd
+			self
+		end
+
+		def parse_tags(hash)
+			tags  = Array.new
+			hash["items"].each do |tag|
+				tags.push(tag['name'])
+			end
+			tags
+		end
+
+	end
+end

data/lib/hukd/version.rb

@@ -0,0 +1,3 @@
+module Hukd
+  VERSION = "1.0.0"
+end

data/spec/hukd_spec.rb

@@ -0,0 +1,52 @@
+require "rspec"
+require "hukd"
+
+describe Hukd::Base do
+
+	it "shouldn't work without an API key'" do
+		expect { Hukd.new("").hottest('deals') }.to raise_error
+	end
+
+	it "should get hottest deals" do
+		Hukd.new("YOUR_API_KEY_HERE").hottest('deals').count.should equal(20)
+	end
+
+	it "should get a custom number of deals" do
+		Hukd.new("YOUR_API_KEY_HERE").hottest('deals','',10).count.should equal(10)
+	end
+
+	it "shouldn't get more than 500 deals" do
+		Hukd.new("YOUR_API_KEY_HERE").hottest('deals','',10000).count.should equal(500)
+	end
+
+	it "should be able to specify a forum" do
+		Hukd.new("YOUR_API_KEY_HERE").hottest('vouchers','',1)[0].forum_url_name.should == "vouchers"
+	end
+
+	it "should be able to specify a category" do
+		Hukd.new("YOUR_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("YOUR_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("YOUR_API_KEY_HERE").user('wishihadadonkey','','',1)[0].poster_name.should ==  "wishihadadonkey"
+	end
+
+	it "should search by tag" do
+		deal  = Hukd.new("YOUR_API_KEY_HERE").tag('xbox','deals','',1)[0].tags.should include('xbox')
+	end
+
+	it "should search by merchant" do
+		Hukd.new("YOUR_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("YOUR_API_KEY_HERE").search('xbox','','',false,1,1)[0].title.should include("xbox")
+	end
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification
+name: hukd
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
+platform: ruby
+authors:
+- Cube Websites
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2157188460 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.6'
+  type: :development
+  prerelease: false
+  version_requirements: *2157188460
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &2157188040 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *2157188040
+description: API Wrapper for HotUKDeals (HUKD)
+email:
+- messages@cubewebsites.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.md
+- Rakefile
+- hukd.gemspec
+- lib/hukd.rb
+- lib/hukd/base.rb
+- lib/hukd/deal.rb
+- lib/hukd/version.rb
+- spec/hukd_spec.rb
+homepage: ''
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: hukd
+rubygems_version: 1.8.15
+signing_key: 
+specification_version: 3
+summary: API Wrapper for HotUKDeals (HUKD)
+test_files:
+- spec/hukd_spec.rb