enom-ruby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 32fc7f2467d71ec7fb9ab6f83a8487bb69b9d3a1
+  data.tar.gz: 0f3886445535f8f62fd6f804f34c7784e3a35e42
+SHA512:
+  metadata.gz: 04237b6ac092643eeb69ea7f160dec44de06532ff466e92592ca9973806155637da8d1ad2610638e1eb17af3438acb924085e38d7ae3bbc9dc24277fffdc995c
+  data.tar.gz: 19c2edad06f2c06a31102986e010cdba2762b2a1a66628181d67e08eef430912ac6c0038c790fd4fc02f4b4fc051b7a2c1a60b4d2a55a13d84c48b61a24775d2

data/.gitignore

@@ -0,0 +1,19 @@
+.DS_Store
+/.env
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/spec/cassettes/**
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+.ruby-gemset
+mkmf.log
+*.gem

data/.ruby-version

@@ -0,0 +1 @@
+2.1.5

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Jeremy Woertink
+
+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,59 @@
+# EnomRuby
+
+A ruby wrapper for the [Enom Reseller](http://www.enom.com/resellers/api-documentation.aspx) API
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'enom-ruby'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install enom-ruby
+
+## Usage
+
+```ruby
+require 'enom-ruby'
+
+EnomRuby::Client.configure do |c|
+  c.username = ENV['ENOM_USERNAME']
+  c.password = ENV['ENOM_PASSWORD']
+  c.test_mode = true
+end
+
+# searches for google.com
+domains = EnomRuby::Domain.check('google')
+
+# searches for google.co, google.org, google.net
+domains = EnomRuby::Domain.check('google', ['co', 'org', 'net'])
+
+domains.first.unavailable? #=> true
+```
+
+## Development
+
+* Add a .env file `touch .env`
+* Then add your `ENOM_USERNAME` and `ENOM_PASSWORD` environment variables.
+* `rspec spec/` to run your tests.
+
+Note that this needs to make an API call, so it will generate VCR cassettes.
+
+## Contribute
+
+1. Fork it ( https://github.com/[my-github-username]/enom-ruby/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 a new Pull Request
+
+## Mentions
+
+Most of this gem is stemmed from James Miller's [Enom](https://github.com/bensie/enom) gem. It worked well, but now I need to add some new things, and check against new TLDs which the enom gem fails with. I also have no use for a command line version

data/Rakefile

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

data/enom-ruby.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'enom-ruby/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "enom-ruby"
+  spec.version       = EnomRuby::VERSION
+  spec.authors       = ["Jeremy Woertink"]
+  spec.email         = ["jeremywoertink@gmail.com"]
+  spec.summary       = %q{Ruby wrapper for the Enom API}
+  spec.description   = %q{EnomRuby is a Ruby wrapper for portions of the Enom domain reseller API.}
+  spec.homepage      = "https://github.com/jwoertink/enom-ruby"
+  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_dependency "httparty", "0.13.3"
+  spec.add_dependency "hashie",   "3.3.2"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "dotenv",  "~> 1.0"
+  spec.add_development_dependency "pry",     "~> 0.10"
+  spec.add_development_dependency "rake",    "~> 10.0"
+  spec.add_development_dependency "rspec",   "~> 3.1"
+  spec.add_development_dependency "vcr",     "~> 2.9"
+  spec.add_development_dependency "webmock", "~> 1.20"
+end

data/lib/enom-ruby.rb

@@ -0,0 +1,6 @@
+require 'enom-ruby/version'
+require 'enom-ruby/client'
+require 'enom-ruby/domain'
+
+module EnomRuby
+end

data/lib/enom-ruby/client.rb

@@ -0,0 +1,42 @@
+require 'httparty'
+
+module EnomRuby
+
+  class Client
+    include HTTParty
+
+    class << self
+      attr_accessor :username, :password, :test_mode
+      alias_method :test?, :test_mode
+
+      def configure
+        yield self
+      end
+
+      # All requests must contain the UID, PW, and ResponseType query parameters
+      def default_params
+        { "UID" => self.username, "PW" => self.password, "ResponseType" => "xml" }
+      end
+
+      # Enom has a test platform and a production platform.  Both are configured to use
+      # HTTPS at all times. Don't forget to configure permitted IPs (in both environments)
+      # or you'll get InterfaceErrors.
+      def base_uri
+        subdomain = test? ? 'resellertest' : 'reseller'
+        "https://#{subdomain}.enom.com/interface.asp"
+      end
+
+      # All requests to Enom are GET requests, even when we're changing data.  Unfortunately,
+      # Enom also does not provide HTTP status codes to alert for authentication failures
+      # or other helpful statuses -- everything comes back as a 200.
+      def request(params = {})
+        response = get(base_uri, query: params.merge(default_params))
+        if Integer(response["interface_response"]["ErrCount"]).zero?
+          return response["interface_response"]
+        else
+          raise InterfaceError, response["interface_response"]["errors"].values.join(", ")
+        end
+      end
+    end
+  end
+end

data/lib/enom-ruby/domain.rb

@@ -0,0 +1,34 @@
+require 'hashie/mash'
+
+module EnomRuby
+
+  class Domain
+    DEFAULT_TLDS = ['com']
+
+    def self.check(sld, tld_list = DEFAULT_TLDS)
+      response = Client.request(command: 'Check', sld: sld, tldlist: tld_list.join(','))
+      domains = Hash[*Array(response['Domain']).zip(Array(response['RRPText'])).flatten]
+      [].tap do |results|
+        domains.each_pair { |domain, text| results << new(domain, text) }
+      end
+    end
+
+    def initialize(domain, availability_text)
+      @domain = domain
+      @availability_text = availability_text
+    end
+
+    def available?
+      @availability_text == 'Domain available'
+    end
+
+    def unavailable?
+      not available?
+    end
+
+    def url
+      @domain
+    end
+
+  end
+end

data/lib/enom-ruby/version.rb

@@ -0,0 +1,3 @@
+module EnomRuby
+  VERSION = "0.1.0"
+end

data/spec/client_spec.rb

@@ -0,0 +1,21 @@
+require_relative 'spec_helper'
+
+RSpec.describe EnomRuby::Client do
+
+  describe '.base_uri' do
+
+    it 'returns the enom test domain when set to test' do
+      expect(EnomRuby::Client.base_uri).to eq "https://resellertest.enom.com/interface.asp"
+    end
+
+    context 'when in production mode' do
+      before { EnomRuby::Client.test_mode = false }
+      after { EnomRuby::Client.test_mode = true }
+
+      it 'returns the enom production domain when test it set to false' do
+        expect(EnomRuby::Client.base_uri).to eq "https://reseller.enom.com/interface.asp"
+      end
+    end
+  end
+
+end

data/spec/domain_spec.rb

@@ -0,0 +1,17 @@
+require_relative 'spec_helper'
+
+RSpec.describe EnomRuby::Domain do
+
+  describe '.check', vcr: true do
+
+    context 'with a valid SLD "google" and no extra TLDs' do
+      it 'returns an array with a single domain object showing unavailable' do
+        domain = EnomRuby::Domain.check('google').first
+        expect(domain).to be_a(EnomRuby::Domain)
+        expect(domain).to be_unavailable
+        expect(domain.url).to eq 'google.com'
+      end
+    end
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,33 @@
+require 'rspec'
+require 'vcr'
+require 'pry'
+require 'dotenv'
+Dotenv.load
+
+$: << File.expand_path('../lib', __FILE__)
+require 'enom-ruby'
+
+real_requests = ENV['REAL_REQUESTS']
+
+VCR.configure do |config|
+  config.cassette_library_dir = "spec/cassettes"
+  config.hook_into :webmock
+  config.configure_rspec_metadata!
+  config.allow_http_connections_when_no_cassette = true if real_requests
+  config.default_cassette_options = {record: :new_episodes}
+end
+
+RSpec.configure do |config|
+  config.filter_run focus: true
+  config.run_all_when_everything_filtered = true
+  config.color = true
+  config.before(:each) {
+    VCR.eject_cassette
+  } if real_requests
+end
+
+EnomRuby::Client.configure do |config|
+  config.username = ENV['ENOM_USERNAME']
+  config.password = ENV['ENOM_PASSWORD']
+  config.test_mode = true
+end

metadata

@@ -0,0 +1,189 @@
+--- !ruby/object:Gem::Specification
+name: enom-ruby
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Jeremy Woertink
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-02 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.13.3
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 3.3.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.20'
+description: EnomRuby is a Ruby wrapper for portions of the Enom domain reseller API.
+email:
+- jeremywoertink@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- enom-ruby.gemspec
+- lib/enom-ruby.rb
+- lib/enom-ruby/client.rb
+- lib/enom-ruby/domain.rb
+- lib/enom-ruby/version.rb
+- spec/cassettes/.keep
+- spec/client_spec.rb
+- spec/domain_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/jwoertink/enom-ruby
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the Enom API
+test_files:
+- spec/cassettes/.keep
+- spec/client_spec.rb
+- spec/domain_spec.rb
+- spec/spec_helper.rb