domainsbot 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0a4c0a83635d284bd3c2b14efb3288780435e177
+  data.tar.gz: 55954ad44c064d389d254ec3d757f440e897e94f
+SHA512:
+  metadata.gz: a428c6aceaddeb58eaea64c8e90a4b7d65390766f0fe25ab409849bda6be2831cf34a5f4bdbdddfe083601814b325edf00310985ccb80ebb23efe6da67eea409
+  data.tar.gz: de51ddbe7057fa78677817d7081cb089e2697f21fc114cf87571753e8b4270ed0d51db2da46e3c30f4c23cc4ca1635c39d7bb814f58bebdc46dade04ee4570cb

data/.gitignore

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

data/Gemfile

@@ -0,0 +1,8 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in domainsbot.gemspec
+gemspec
+
+group :test do
+    gem 'webmock'
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Daniel Westendorf
+
+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,34 @@
+# Domainsbot
+
+Simple Ruby API for http://domainsbot.com
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'domainsbot'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install domainsbot
+
+## Usage
+
+    require 'domainsbot'
+
+    Domainsbot.api_key = 'MY_API_KEY'
+    Domainsbot.suggest(q: 'my-fancy-domain-name.com')
+
+Suggest will add all the options passed to it as query params in the request
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/domainsbot/fork )
+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,12 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'lib/domainsbot'
+  t.test_files = FileList['test/lib/domainsbot_test.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/domainsbot.gemspec

@@ -0,0 +1,22 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "domainsbot"
+  spec.version       = "0.0.1"
+  spec.authors       = ["Daniel Westendorf"]
+  spec.email         = ["daniel@prowestech.com"]
+  spec.summary       = %q{Simple ruby client for domainsbot.com's api}
+  spec.description   = %q{Simple ruby client for domainsbot.com's api}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+end

data/lib/domainsbot.rb

@@ -0,0 +1,57 @@
+# Simple API wrapper for the Domainsbot API
+# Visit https://developers.domainsbot.com/docs for more information about the API
+# Built for API v4
+#
+# Author:: Daniel Westendorf (daniel@prowestech.com)
+# License:: MIT
+
+require 'net/http'
+require 'json'
+
+class Domainsbot
+    @@api_key = nil
+
+    BASE_URI = 'https://api.domainsbot.com/v4'
+
+    # Set the API key to be used for all requests
+    #
+    # ==== Attributes
+    #
+    # * +key+ - String Domainsbot API Key
+    #
+    # ==== Examples
+    #
+    #    Domainsbot.api_key = "MYAPIKEY"
+    def self.api_key=(key)
+        @@api_key = key
+    end
+
+    def self.api_key; @@api_key; end
+
+    # Accepts a hash of options
+    # All options will be added as a query paramerter
+
+    # ==== Attributes
+    #
+    # * +options+ - Hash query parameters
+    #
+    # ==== Examples
+    #
+    #    Domainsbot.suggest({q: 'example.com', pageSize: 2, tlds: 'com,org,net'})
+    def self.suggest(options={q: '', pageSize: 25, tlds: 'com,org,net', format: 'json'})
+        options['auth-token'] = @@api_key
+        options[:json] = 'json'
+        uri = build_uri('/spinner', options)
+
+        response = Net::HTTP.get_response(uri)
+        return JSON.parse(response.body)
+    end
+
+    # Helper method for building the URI
+    # Shouldn't ever be called directly
+    def self.build_uri(path, options) #:nodoc: all
+        uri = URI("#{BASE_URI}#{path}")
+        uri.query = URI.encode_www_form(options)
+        return uri
+    end
+end

data/test/lib/domainsbot_test.rb

@@ -0,0 +1,34 @@
+require_relative '../test_helper'
+
+describe Domainsbot do
+    API_KEY = '123456'
+    before do
+        Domainsbot.api_key = API_KEY
+    end
+
+    it "must have an api_key defined" do
+        Domainsbot.api_key.wont_be_nil
+    end
+
+
+    it '#build_uri' do
+        uri = Domainsbot.build_uri('/spinner', {pageSize: 40, q: 'flubber'})
+        assert_equal("https://api.domainsbot.com/v4/spinner?pageSize=40&q=flubber", uri.to_s)
+    end
+
+    describe '#suggest' do
+
+        before do
+            stub_request(:get, "https://api.domainsbot.com/v4/spinner").
+                with(query: hash_including({}),:headers => {'Accept'=>'*/*', 'Accept-Encoding'=>'gzip;q=1.0,deflate;q=0.6,identity;q=0.3', 'Host'=>'api.domainsbot.com', 'User-Agent'=>'Ruby'}).
+                to_return(status: 200, headers: {'Content-Type' => 'application/json'}, body: RESPONSE_DATA)
+        end
+
+        it "always gets a JSON Hash response" do
+            response = Domainsbot.suggest(q: 'hotpeppers.com', format: 'xml')
+            assert_kind_of(Hash, response)
+        end
+
+    end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,8 @@
+require 'bundler'
+Bundler.require(:default, :test)
+require 'minitest/autorun'
+require 'minitest/pride'
+require 'webmock/minitest'
+require File.expand_path('../../lib/domainsbot.rb', __FILE__)
+
+RESPONSE_DATA = '{"Domains":[{"Extension":"com","DomainName":"DirectlyBuilt.com","NameWithoutExtension":"DirectlyBuilt","Keys":["directly","built"],"Data":[[{"Name":"database","Data":"available"},{"Name":"language","Data":"en"},{"Name":"PercentileRank","Data":99},{"Name":"length","Data":13},{"Name":"keyscount","Data":2},{"Name":"bad","Data":false},{"Name":"dash","Data":false},{"Name":"numbers","Data":false},{"Name":"idn","Data":false},{"Name":"#synonyms","Data":true}]]},{"Extension":"com","DomainName":"StraightforwardBuilt.com","NameWithoutExtension":"StraightforwardBuilt","Keys":["straightforward","built"],"Data":[[{"Name":"database","Data":"available"},{"Name":"language","Data":"en"},{"Name":"PercentileRank","Data":99},{"Name":"length","Data":20},{"Name":"keyscount","Data":2},{"Name":"bad","Data":false},{"Name":"dash","Data":false},{"Name":"numbers","Data":false},{"Name":"idn","Data":false},{"Name":"#synonyms","Data":true}]]}],"Keys":[["simply","directly","straightforward","plainly","modestly"],["built"]],"PageIndex":0,"PageSize":2,"TotalResults":347}'

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: domainsbot
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Westendorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Simple ruby client for domainsbot.com's api
+email:
+- daniel@prowestech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- domainsbot.gemspec
+- lib/domainsbot.rb
+- test/lib/domainsbot_test.rb
+- test/test_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Simple ruby client for domainsbot.com's api
+test_files:
+- test/lib/domainsbot_test.rb
+- test/test_helper.rb