domainr 0.3.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6bf2a895932dc0a644e69b58273546a8c5b80b27
-  data.tar.gz: c04c463acfb2dfd58820bb802073c2a692d0b723
+  metadata.gz: 2f3dca9b3449f32e2a54c52f63160064d64b1600
+  data.tar.gz: abed36cdfb84dce7364959200b0efcaff27d682e
 SHA512:
-  metadata.gz: 61709312a0d83ba43dbb689130dab896e93d59a69afe8a087efb09d1cb86eaa326d50046293a90c537cc91f0940d755fc5b435cb0b3670c50edd4f104fc2a5e7
-  data.tar.gz: 8d3a9dcb449994ab51645cdfa8ba5c241a5f2049be5f984e6af9523ef36e2dfcd38393c8defdd1a441fd2c25934f7ea4a29c6f1fec45c92aa2c7a016fa120ef3
+  metadata.gz: 53d3cf3e64837cbdc63aa35ccf535385a1a91f36b0efd0bdf094f43208f21bc6eb4390d7e226add77ab8d83c6b7e88fc0369f8c065387f6047625a3053852c62
+  data.tar.gz: 2631250f4efc1859f4cc01474c0e6753f1058f7fa7751fd7f10bf213d2d79adb3db903f0ed81da90dd7537c3ed5ddfae2763fd2482de29a332d50eb46385bbac

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2014 Steve Agalloco
+Copyright (c) 2016 Steve Agalloco
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,6 +1,6 @@
 # domainr
 
-Ruby wrapper for the [Domainr API](https://domainr.com/api).
+Ruby wrapper for the [Domainr API](http://domainr.build/).
 
 ## Installation
 
@@ -8,13 +8,26 @@ Ruby wrapper for the [Domainr API](https://domainr.com/api).
 
 ## Usage
 
-You can use Domainr to retrieve information about a domain:
+Instantiate a new client:
 
-    Domainr.info('google.com')
+    client = Domainr::Client.new(mashape_key: 'abcdefghijklmnopqrstuvwxyz')
+
+If you are using Domainr's high volume API endpoints, you can pass a `client_id` and `endpoint` instead:
+
+    client = Domainr::Client.new(client_id: '123456789', endpoint: 'https://api.domainr.com')
+
+Once configured, you can use the `Domainr::Client` to retrieve information about a domain:
+
+    client.status('google.com')
 
 You can also search Domainr based on a search term:
 
-    Domainr.search('twitter')
+    client.search('twitter')
+
+## Documentation
+[http://rdoc.info/gems/domainr][documentation]
+
+[documentation]: http://rdoc.info/gems/domainr}}
 
 ## Contributing
 
@@ -22,4 +35,4 @@ Pull requests welcome: fork, make a topic branch, commit (squash when possible)
 
 ## Copyright
 
-Copyright (c) 2014 Steve Agalloco. See [LICENSE](LICENSE.md) for detail
+Copyright (c) 2016 Steve Agalloco. See [LICENSE](LICENSE.md) for detail

data/domainr.gemspec

@@ -4,25 +4,18 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'domainr/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = 'domainr'
-  spec.version       = Domainr::VERSION
-  spec.homepage      = 'https://github.com/stve/domainr'
-
+  spec.add_dependency 'http', '~> 1.0'
+  spec.add_dependency 'virtus', '~> 1.0'
+  spec.add_development_dependency 'bundler', '~> 1.0'
   spec.author        = "Steve Agalloco"
-  spec.email         = 'steve.agalloco@gmail.com'
   spec.description   = 'Ruby wrapper for the Domainr API'
-  spec.summary       = 'Ruby wrapper for the Domainr API'
-
+  spec.email         = 'steve.agalloco@gmail.com'
+  spec.files         = %w(LICENSE.md README.md domainr.gemspec) + Dir['lib/**/*.rb']
+  spec.homepage      = 'https://github.com/stve/domainr'
   spec.licenses      = ['MIT']
-
-  spec.executables   = Dir.glob("bin/**/*")
-  spec.files         = %w(.yardopts LICENSE.md README.md Rakefile domainr.gemspec)
-  spec.files         += Dir.glob("lib/**/*.rb")
-  spec.files         += Dir.glob("spec/**/*")
-  spec.test_files    = Dir.glob("spec/**/*")
-
-  spec.add_dependency(%q<httparty>, [">= 0.5.2"])
-  spec.add_dependency(%q<hashie>, [">= 0.2.0"])
-
+  spec.name          = 'domainr'
   spec.require_paths = ['lib']
+  spec.required_ruby_version = '>= 2.0.0'
+  spec.summary       = 'Domainr API Ruby Client'
+  spec.version       = Domainr::VERSION
 end

data/lib/domainr.rb

@@ -1,29 +1 @@
-require 'hashie'
-require 'httparty'
-
-module Domainr
-  extend self
-
-  include HTTParty
-  format :json
-  base_uri 'https://api.domainr.com'
-
-  def self.client_id=(id)
-    @client_id = id
-  end
-
-  def self.client_id
-    @client_id || 'domainr_rubygem'
-  end
-
-  def search(term)
-    options = { :q => term, :client_id => client_id }
-    Hashie::Mash.new(get('/v1/search', { :query => options }))
-  end
-
-  def info(domain)
-    options = { :q => domain, :client_id => client_id }
-    Hashie::Mash.new(get('/v1/info', { :query => options }))
-  end
-
-end
+require 'domainr/client'

data/lib/domainr/client.rb

@@ -0,0 +1,55 @@
+require 'http'
+require 'domainr/domain'
+require 'domainr/http/response'
+
+module Domainr
+  class Client
+    DEFAULT_ENDPOINT = 'https://domainr.p.mashape.com'
+
+    attr_accessor :client_id, :mashape_key, :endpoint
+
+    def initialize(options = {})
+      @client_id = options.delete(:client_id)
+      @mashape_key = options.delete(:mashape_key)
+      @endpoint = options.delete(:endpoint) || DEFAULT_ENDPOINT
+    end
+
+    def search(query, options = {})
+      perform_get_with_objects('/v2/search', options.merge(query: query), 'results', Domainr::Domain)
+    end
+
+    def status(domain, options = {})
+      perform_get_with_objects('/v2/status', options.merge(domain: domain), 'status', Domainr::Domain)
+    end
+
+    private
+
+    # @param path [String]
+    # @param options [Hash]
+    # @param response_path [String]
+    # @param klass [Class]
+    def perform_get_with_objects(path, options, response_path, klass)
+      perform_request(path, options)[response_path].collect do |element|
+        klass.new(element)
+      end
+    end
+
+    def perform_request(path, params)
+      response = ::HTTP.headers(accept: 'application/json')
+                       .get(endpoint + path, params: params.merge(authentication_params))
+
+      resp = Domainr::HTTP::Response.new(response)
+      resp.valid? && resp.body
+    end
+
+    def authentication_params
+      if mashape_key
+        {'mashape-key' => mashape_key}
+      elsif client_id
+        {'client_id' => client_id}
+      else
+        {}
+      end
+    end
+  end
+end

data/lib/domainr/domain.rb

@@ -0,0 +1,15 @@
+require 'virtus'
+
+module Domainr
+  class Domain
+    include Virtus.value_object
+
+    attribute :domain, String
+    attribute :host, String
+    attribute :subdomain, String
+    attribute :zone, String
+    attribute :path, String
+    attribute :register_url, String
+    attribute :summary, String
+  end
+end

data/lib/domainr/error.rb

@@ -0,0 +1,20 @@
+module Domainr
+  class Error < StandardError
+    # @return [Integer]
+    attr_reader :code
+
+    def self.from_response(error)
+      new(error['message'], error['status'])
+    end
+
+    # Initializes a new Error object
+    #
+    # @param message [Exception, String]
+    # @param code [Integer]
+    # @return [Instapaper::Error]
+    def initialize(message = '', code = nil)
+      super(message)
+      @code = code
+    end
+  end
+end

data/lib/domainr/http/response.rb

@@ -0,0 +1,44 @@
+require 'domainr/error'
+
+module Domainr
+  module HTTP
+    class Response
+      attr_reader :response
+
+      def initialize(response)
+        @response = response
+      end
+
+      def valid?
+        !error?
+      end
+
+      def error?
+        fail_if_body_contains_error
+        fail_if_http_error
+      end
+
+      def body
+        parsed
+      end
+
+      private
+
+      def parsed
+        response.parse(:json)
+      end
+
+      def fail_if_http_error
+        return if response.status.ok?
+
+        raise Domainr::Error.new(response.status.reason, response.status.code)
+      end
+
+      def fail_if_body_contains_error
+        if parsed.key?('error')
+          raise Domainr::Error.from_response(parsed['error'])
+        end
+      end
+    end
+  end
+end

data/lib/domainr/version.rb

@@ -1,3 +1,3 @@
 module Domainr
-  VERSION = '0.3.0'
+  VERSION = '1.0.0'
 end

metadata

@@ -1,62 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: domainr
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Steve Agalloco
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-08 00:00:00.000000000 Z
+date: 2016-02-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: httparty
+  name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.5.2
+        version: '1.0'
 - !ruby/object:Gem::Dependency
-  name: hashie
+  name: virtus
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
 description: Ruby wrapper for the Domainr API
 email: steve.agalloco@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".yardopts"
 - LICENSE.md
 - README.md
-- Rakefile
 - domainr.gemspec
 - lib/domainr.rb
+- lib/domainr/client.rb
+- lib/domainr/domain.rb
+- lib/domainr/error.rb
+- lib/domainr/http/response.rb
 - lib/domainr/version.rb
-- spec/domainr_spec.rb
-- spec/fixtures/empty_info.json
-- spec/fixtures/empty_search.json
-- spec/fixtures/info.json
-- spec/fixtures/search.json
-- spec/spec_helper.rb
 homepage: https://github.com/stve/domainr
 licenses:
 - MIT
@@ -69,7 +79,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 2.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -77,15 +87,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.2
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
-summary: Ruby wrapper for the Domainr API
-test_files:
-- spec/domainr_spec.rb
-- spec/fixtures/empty_info.json
-- spec/fixtures/empty_search.json
-- spec/fixtures/info.json
-- spec/fixtures/search.json
-- spec/spec_helper.rb
+summary: Domainr API Ruby Client
+test_files: []
 has_rdoc: 

data/.yardopts

@@ -1,3 +0,0 @@
---markup markdown
--
-LICENSE.md

data/Rakefile

@@ -1,19 +0,0 @@
-#!/usr/bin/env rake
-
-require 'bundler/gem_tasks'
-
-require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec) do |t|
-  t.ruby_opts = '-w'
-end
-
-task :default => :spec
-task :test => :spec
-
-require 'yard'
-namespace :doc do
-  YARD::Rake::YardocTask.new do |task|
-    task.files   = ['LICENSE.md', 'lib/**/*.rb']
-    task.options = ['--markup', 'markdown']
-  end
-end

data/spec/domainr_spec.rb

@@ -1,73 +0,0 @@
-RSpec.describe Domainr do
-
-  describe '#client_id=' do
-    after do
-      Domainr.client_id = nil
-    end
-
-    it 'returns "domainr_rubygem" by default' do
-      expect(Domainr.client_id).to eq('domainr_rubygem')
-    end
-
-    it 'allows a client_id to be defined' do
-      Domainr.client_id = 'domainr_test_suite'
-      expect(Domainr.client_id).to eq('domainr_test_suite')
-    end
-  end
-
-  describe '#search' do
-    context "with a search term" do
-      subject { Domainr.search('domainr') }
-
-      it "includes the query term" do
-        expect(subject.query).to eq('domainr')
-      end
-
-      it "returns results" do
-        expect(subject.results.size).to eq(16)
-
-        first_result = subject.results.first
-        expect(first_result.domain).to eq('domainr.com')
-        expect(first_result.availability).to eq('maybe')
-
-        second_result = subject.results[1]
-        expect(second_result.domain).to eq('domainr.net')
-        expect(second_result.availability).to eq('maybe')
-      end
-    end
-
-    context "without a search term" do
-      subject { Domainr.search(nil) }
-
-      it "returns an error" do
-        expect(subject.results.size).to eq(0)
-        expect(subject.error).to be
-        expect(subject.error.status).to eq(404)
-        expect(subject.error.message).to eq('No results found.')
-      end
-    end
-  end
-
-  context "Retrieving info from Domainr" do
-    context "with a valid search term"do
-      subject { Domainr.info('domai.nr') }
-
-      it "return results" do
-        expect(subject.registrars)
-        expect(subject.domain).to eq('domai.nr')
-        expect(subject.availability).to eq('taken')
-        expect(subject.tld.domain).to eq('nr')
-      end
-    end
-
-    context "with an invalid search term" do
-      subject { Domainr.info('d') }
-
-      it "returns an error" do
-        expect(subject.error).to be
-        expect(subject.error.status).to eq(404)
-        expect(subject.error.message).to eq('No results found.')
-      end
-    end
-  end
-end

data/spec/fixtures/empty_info.json

@@ -1,10 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: text/javascript+json
-Date: Wed, 07 Jul 2010 03:36:37 GMT
-Server: Google Frontend
-Cache-Control: private, x-gzip-ok=""
-X-Xss-Protection: 0
-Transfer-Encoding: Identity
-Connection: close
-
-{"query": "d", "error": {"status": 404, "message": "No results found."}}

data/spec/fixtures/empty_search.json

@@ -1,10 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: text/javascript+json
-Date: Wed, 07 Jul 2010 03:27:35 GMT
-Server: Google Frontend
-Cache-Control: private, x-gzip-ok=""
-X-Xss-Protection: 0
-Transfer-Encoding: Identity
-Connection: close
-
-{"query": "", "results": [], "error": {"status": 404, "message": "No results found."}}

data/spec/fixtures/info.json

@@ -1,10 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: text/javascript+json
-Date: Wed, 07 Jul 2010 02:48:41 GMT
-Server: Google Frontend
-Cache-Control: private, x-gzip-ok=""
-X-Xss-Protection: 0
-Transfer-Encoding: Identity
-Connection: close
-
-{"domain": "domai.nr", "whois_url": "http://domainr.com/domai.nr/whois", "register_url": "http://domainr.com/domai.nr/register", "tld": {"domain": "nr", "domain_idna": "nr", "wikipedia_url": "http://wikipedia.org/wiki/.nr", "iana_url": "http://www.iana.org/domains/root/db/nr.html"}, "registrars": [{"registrar": "cenpac.net.nr", "name": "CenpacNET", "register_url": "http://domainr.com/domai.nr/register/cenpac.net.nr"}], "host": "", "path": "", "www_url": "http://domainr.com/domai.nr/www", "query": "domai.nr", "subdomain": "domai.nr", "domain_idna": "domai.nr", "availability": "taken"}

data/spec/fixtures/search.json

@@ -1,10 +0,0 @@
-HTTP/1.1 200 OK
-Content-Type: text/javascript+json
-Date: Wed, 07 Jul 2010 02:49:22 GMT
-Server: Google Frontend
-Cache-Control: private, x-gzip-ok=""
-X-Xss-Protection: 0
-Transfer-Encoding: Identity
-Connection: close
-
-{"query": "domainr", "results": [{"domain": "domainr.com", "register_url": "http://domainr.com/domainr.com/register", "host": "", "path": "", "subdomain": "domainr.com", "availability": "maybe"}, {"domain": "domainr.net", "register_url": "http://domainr.com/domainr.net/register", "host": "", "path": "", "subdomain": "domainr.net", "availability": "maybe"}, {"domain": "domainr.org", "register_url": "http://domainr.com/domainr.org/register", "host": "", "path": "", "subdomain": "domainr.org", "availability": "maybe"}, {"domain": "domai.nr", "register_url": "http://domainr.com/domai.nr/register", "host": "", "path": "", "subdomain": "domai.nr", "availability": "taken"}, {"domain": "doma.in", "register_url": "http://domainr.com/doma.in/register", "host": "", "path": "/r", "subdomain": "doma.in", "availability": "maybe"}, {"domain": "dom.ai", "register_url": "http://domainr.com/dom.ai/register", "host": "", "path": "/nr", "subdomain": "dom.ai", "availability": "maybe"}, {"domain": "do.ma", "register_url": "http://domainr.com/do.ma/register", "host": "", "path": "/inr", "subdomain": "do.ma", "availability": "maybe"}, {"domain": "d.om", "register_url": "http://domainr.com/d.om/register", "host": "", "path": "/ainr", "subdomain": "d.om", "availability": "unavailable"}, {"domain": "dm.nr", "register_url": "http://domainr.com/dm.nr/register", "host": "", "path": "", "subdomain": "dm.nr", "availability": "maybe"}, {"domain": "d.mai.nr", "register_url": "http://domainr.com/d.mai.nr/register", "host": "d.", "path": "", "subdomain": "mai.nr", "availability": "available"}, {"domain": "d.mn", "register_url": "http://domainr.com/d.mn/register", "host": "", "path": "/r", "subdomain": "d.mn", "availability": "unavailable"}, {"domain": "d.ma.in", "register_url": "http://domainr.com/d.ma.in/register", "host": "d.", "path": "/r", "subdomain": "ma.in", "availability": "unavailable"}, {"domain": "d.m.ai", "register_url": "http://domainr.com/d.m.ai/register", "host": "d.", "path": "/nr", "subdomain": "m.ai", "availability": "taken"}, {"domain": "d.ma", "register_url": "http://domainr.com/d.ma/register", "host": "", "path": "/inr", "subdomain": "d.ma", "availability": "available"}, {"domain": "dm", "register_url": "http://domainr.com/dm/register", "host": "", "path": "/nr", "subdomain": "dm", "availability": "tld"}, {"domain": "do", "register_url": "http://domainr.com/do/register", "host": "", "path": "/mainr", "subdomain": "do", "availability": "tld"}]}

data/spec/spec_helper.rb

@@ -1,25 +0,0 @@
-# encoding: utf-8
-unless ENV['CI']
-  require 'simplecov'
-  SimpleCov.start do
-    add_group 'Domainr', 'lib/domainr'
-    add_group 'Specs', 'spec'
-  end
-end
-
-require 'fakeweb'
-require 'domainr'
-
-FakeWeb.allow_net_connect = false
-
-FakeWeb.register_uri(:get, "https://api.domainr.com/v1/info?q=domai.nr&client_id=domainr_rubygem", :response => File.join(File.dirname(__FILE__), 'fixtures', 'info.json'), :content_type => "text/javascript+json; charset=utf-8", :status => ["200", "OK"])
-FakeWeb.register_uri(:get, "https://api.domainr.com/v1/info?q=d&client_id=domainr_rubygem", :response => File.join(File.dirname(__FILE__), 'fixtures', 'empty_info.json'), :content_type => "text/javascript+json; charset=utf-8", :status => ["200", "OK"])
-FakeWeb.register_uri(:get, "https://api.domainr.com/v1/search?q=domainr&client_id=domainr_rubygem", :response => File.join(File.dirname(__FILE__), 'fixtures', 'search.json'), :content_type => "text/javascript+json; charset=utf-8", :status => ["200", "OK"])
-FakeWeb.register_uri(:get, "https://api.domainr.com/v1/search?q=&client_id=domainr_rubygem", :response => File.join(File.dirname(__FILE__), 'fixtures', 'empty_search.json'), :content_type => "text/javascript+json; charset=utf-8", :status => ["200", "OK"])
-
-RSpec.configure do |config|
-  config.order = :random
-  config.expect_with :rspec do |expectations|
-    expectations.syntax = :expect
-  end
-end