duck_duck_go_api 0.0.1

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+InstalledFiles
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+
+# YARD artifacts
+.yardoc
+_yardoc
+doc/

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - "1.9.2"
+  - "1.9.3"
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-19mode
+# uncomment this line if your project needs to run something other than `rake`:
+script: bundle exec rspec spec

data/CHANGELOG

@@ -0,0 +1,3 @@
+## v0.0.1
+
+* Initial release

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 TM Lee
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,40 @@
+[![Build Status](https://travis-ci.org/tmlee/duck_duck_go_api.png)](https://travis-ci.org/tmlee/duck_duck_go_api)
+
+# DuckDuckGoApi
+
+Lightweight, flexible library for the Duck Duck Go API (https://duckduckgo.com/api) in Ruby 
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'duck_duck_go_api', git: 'git://github.com/tmlee/duck_duck_go_api.git'
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+Call the API directly via the DuckDuckGoApi::Client. Pass in parameters such as (q, format, etc..)
+Parameters map 1-1 as stated in the documentation https://duckduckgo.com/api
+
+### You'll need the DuckDuckGoApi::Client
+	
+	client = DuckDuckGoApi::Client
+
+### Query Anything!
+
+	client.query :q => "github", :format => "json"
+
+### Parameters Maps 1-1 in https://duckduckgo.com/api
+
+	client.query :q => "github", :format => "json", :no_html => 1, :skip_disambig => 1
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

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

data/duck_duck_go_api.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'duck_duck_go_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "duck_duck_go_api"
+  spec.version       = DuckDuckGoApi::VERSION
+  spec.authors       = ["TM Lee"]
+  spec.email         = ["tm89lee@gmail.com"]
+  spec.description   = %q{Duck Duck Go API for Ruby}
+  spec.summary       = %q{Lightweight, flexible library for the Duck Duck Go API in Ruby}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency('faraday', '~> 0.8')
+  spec.add_dependency('json', '~> 1.7.7')
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec", "~> 2.13.0"
+  spec.add_development_dependency("fakeweb", "~> 1.3.0")
+end

data/lib/duck_duck_go_api.rb

@@ -0,0 +1,79 @@
+require "duck_duck_go_api/version"
+require "faraday"
+require "json"
+
+module DuckDuckGoApi
+  class Client
+  	BASE_URL = 'https://api.duckduckgo.com'
+	
+  	class << self
+  		def query(options={})
+  			api_call '', options
+  		end
+		
+			############## Private API Call Method ##############
+  		private
+		
+			def api_url
+				BASE_URL + '/'
+			end
+		
+			def api_call(method_name, options, verb=:get)
+				response = connection(method_name, options, verb)
+				parse_response response
+			end
+		
+			def parse_response(response)
+				raise_errors response
+				if response.body == " "
+					{}
+				else
+					JSON.parse response.body
+				end
+			end
+		
+			def connection(method_name, options, verb)
+		
+				conn = Faraday.new(:url => api_url) do |faraday|
+					faraday.request  :url_encoded
+					faraday.adapter  Faraday.default_adapter
+				end
+				response = conn.get(method_name + "?" + to_query_params(options))
+			end
+		
+		
+			def to_query_params(options)
+				options.collect { |key, value| "#{key}=#{value}" }.join('&')
+			end
+		
+			def raise_errors(response)
+				message = "(#{response.status})"
+				
+				case response.status.to_i
+				  when 400
+				    raise BadRequest, message
+				  when 401
+				    raise Unauthorized, message
+				  when 403
+				    raise General, message
+				  when 404
+				    raise NotFound, message
+				  when 500
+				    raise InternalError, "An internal error is thrown."
+				  when 502..503
+				    raise Unavailable, message
+				end
+			end
+
+		end
+
+	end
+
+	class BadRequest < StandardError; end
+  class Unauthorized      < StandardError; end
+  class General           < StandardError; end
+  class Unavailable       < StandardError; end
+  class InternalError     < StandardError; end
+  class NotFound          < StandardError; end
+
+end

data/lib/duck_duck_go_api/version.rb

@@ -0,0 +1,3 @@
+module DuckDuckGoApi
+  VERSION = "0.0.1"
+end

data/spec/duck_duck_go_api_spec.rb

@@ -0,0 +1,24 @@
+require 'spec_helper'
+require 'duck_duck_go_api'
+
+describe DuckDuckGoApi do
+
+	before :all do
+		@client = DuckDuckGoApi::Client
+	end
+
+	it "makes basic api call when passed in parameter q and format" do
+		stub_get("https://api.duckduckgo.com/?q=github&format=json", 'response.json')
+		result = @client.query :q => "github", :format => "json"
+		expect(result["Heading"]).to eql("GitHub")
+	end
+
+	context "passing parameter no_html" do
+		it "returns api response with no_html" do
+			stub_get("https://api.duckduckgo.com/?q=github&format=json&no_html=1", 'response.json')
+			result = @client.query :q => "github", :format => "json", :no_html => 1
+			expect(result["Results"].first["Result"]).to_not eql("<a href=\"https://github.com/\"><b>Official site</b></a><a href=\"https://github.com/\"></a>")
+		end	
+	end
+	
+end

data/spec/fixtures/no_html.json

@@ -0,0 +1,59 @@
+{
+   "Definition" : "",
+   "DefinitionSource" : "",
+   "Heading" : "GitHub",
+   "AbstractSource" : "Wikipedia",
+   "Image" : "https://i.duckduckgo.com/i/27ff1233.png",
+   "RelatedTopics" : [
+      {
+         "Result" : "<a href=\"http://duckduckgo.com/c/Bug_and_issue_tracking_software\">Bug and issue tracking software</a>",
+         "Icon" : {
+            "URL" : "",
+            "Height" : "",
+            "Width" : ""
+         },
+         "FirstURL" : "http://duckduckgo.com/c/Bug_and_issue_tracking_software",
+         "Text" : "Bug and issue tracking software"
+      },
+      {
+         "Result" : "<a href=\"http://duckduckgo.com/c/Computing_websites\">Computing websites</a>",
+         "Icon" : {
+            "URL" : "",
+            "Height" : "",
+            "Width" : ""
+         },
+         "FirstURL" : "http://duckduckgo.com/c/Computing_websites",
+         "Text" : "Computing websites"
+      },
+      {
+         "Result" : "<a href=\"http://duckduckgo.com/c/Project_management_software\">Project management software</a>",
+         "Icon" : {
+            "URL" : "",
+            "Height" : "",
+            "Width" : ""
+         },
+         "FirstURL" : "http://duckduckgo.com/c/Project_management_software",
+         "Text" : "Project management software"
+      }
+   ],
+   "AbstractText" : "GitHub is a web-based hosting service for software development projects that use the Git revision control system.",
+   "Abstract" : "GitHub is a web-based hosting service for software development projects that use the Git revision control system.",
+   "AnswerType" : "",
+   "Redirect" : "",
+   "Type" : "A",
+   "DefinitionURL" : "",
+   "Answer" : "",
+   "Results" : [
+      {
+         "Result" : "<a href=\"https://github.com/\">Official site</a><a href=\"https://github.com/\"></a>",
+         "Icon" : {
+            "URL" : "https://i.duckduckgo.com/i/github.com.ico",
+            "Height" : 16,
+            "Width" : 16
+         },
+         "FirstURL" : "https://github.com/",
+         "Text" : "Official site"
+      }
+   ],
+   "AbstractURL" : "https://en.wikipedia.org/wiki/GitHub"
+}

data/spec/fixtures/response.json

@@ -0,0 +1 @@
+{"Definition":"","DefinitionSource":"","Heading":"GitHub","AbstractSource":"Wikipedia","Image":"https://i.duckduckgo.com/i/27ff1233.png","RelatedTopics":[{"Result":"<a href=\"http://duckduckgo.com/c/Bug_and_issue_tracking_software\">Bug and issue tracking software</a>","Icon":{"URL":"","Height":"","Width":""},"FirstURL":"http://duckduckgo.com/c/Bug_and_issue_tracking_software","Text":"Bug and issue tracking software"},{"Result":"<a href=\"http://duckduckgo.com/c/Computing_websites\">Computing websites</a>","Icon":{"URL":"","Height":"","Width":""},"FirstURL":"http://duckduckgo.com/c/Computing_websites","Text":"Computing websites"},{"Result":"<a href=\"http://duckduckgo.com/c/Project_management_software\">Project management software</a>","Icon":{"URL":"","Height":"","Width":""},"FirstURL":"http://duckduckgo.com/c/Project_management_software","Text":"Project management software"}],"AbstractText":"GitHub is a web-based hosting service for software development projects that use the Git revision control system.","Abstract":"GitHub is a web-based hosting service for software development projects that use the Git revision control system.","AnswerType":"","Redirect":"","Type":"A","DefinitionURL":"","Answer":"","Results":[{"Result":"<a href=\"https://github.com/\">Official site</a><a href=\"https://github.com/\"></a>","Icon":{"URL":"https://i.duckduckgo.com/i/github.com.ico","Height":16,"Width":16},"FirstURL":"https://github.com/","Text":"Official site"}],"AbstractURL":"https://en.wikipedia.org/wiki/GitHub"}

data/spec/spec_helper.rb

@@ -0,0 +1,36 @@
+require 'rspec'
+require 'duck_duck_go_api'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+def fixture_file(filename, options={})
+  return '' if filename == ''
+
+  file_path = File.expand_path(File.dirname(__FILE__) + '/fixtures/' + filename)
+  fixture   = File.read(file_path)
+
+  case File.extname(file_path)
+    when '.json'
+      options[:parse] ? JSON.parse(fixture) : fixture
+    else
+      fixture
+  end
+end
+
+
+def stub_get(url, filename, options={})
+  opts = {
+    :body => error_or_standard_body(filename, options)
+  }.merge(options)
+  FakeWeb.register_uri(:get, url, opts)
+end
+
+def error_or_standard_body(filename, options)
+  error_options = options.delete(:error)
+  body = fixture_file(error_options ? 'error_template.json' : filename)
+  body = body.gsub(/%error_code%/, error_options[:code])
+             .gsub(/%error_type%/, error_options[:type])
+             .gsub(/%error_message%/, error_options[:message]) if error_options
+  body
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: duck_duck_go_api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- TM Lee
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.13.0
+- !ruby/object:Gem::Dependency
+  name: fakeweb
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.3.0
+description: Duck Duck Go API for Ruby
+email:
+- tm89lee@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- CHANGELOG
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- duck_duck_go_api.gemspec
+- lib/duck_duck_go_api.rb
+- lib/duck_duck_go_api/version.rb
+- spec/duck_duck_go_api_spec.rb
+- spec/fixtures/no_html.json
+- spec/fixtures/response.json
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+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: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: Lightweight, flexible library for the Duck Duck Go API in Ruby
+test_files:
+- spec/duck_duck_go_api_spec.rb
+- spec/fixtures/no_html.json
+- spec/fixtures/response.json
+- spec/spec_helper.rb
+has_rdoc: