enom-ruby 0.1.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +7 -0
- data/.gitignore +19 -0
- data/.ruby-version +1 -0
- data/Gemfile +4 -0
- data/LICENSE.txt +22 -0
- data/README.md +59 -0
- data/Rakefile +2 -0
- data/enom-ruby.gemspec +31 -0
- data/lib/enom-ruby.rb +6 -0
- data/lib/enom-ruby/client.rb +42 -0
- data/lib/enom-ruby/domain.rb +34 -0
- data/lib/enom-ruby/version.rb +3 -0
- data/spec/client_spec.rb +21 -0
- data/spec/domain_spec.rb +17 -0
- data/spec/spec_helper.rb +33 -0
- metadata +189 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA1:
|
3
|
+
metadata.gz: 32fc7f2467d71ec7fb9ab6f83a8487bb69b9d3a1
|
4
|
+
data.tar.gz: 0f3886445535f8f62fd6f804f34c7784e3a35e42
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: 04237b6ac092643eeb69ea7f160dec44de06532ff466e92592ca9973806155637da8d1ad2610638e1eb17af3438acb924085e38d7ae3bbc9dc24277fffdc995c
|
7
|
+
data.tar.gz: 19c2edad06f2c06a31102986e010cdba2762b2a1a66628181d67e08eef430912ac6c0038c790fd4fc02f4b4fc051b7a2c1a60b4d2a55a13d84c48b61a24775d2
|
data/.gitignore
ADDED
data/.ruby-version
ADDED
@@ -0,0 +1 @@
|
|
1
|
+
2.1.5
|
data/Gemfile
ADDED
data/LICENSE.txt
ADDED
@@ -0,0 +1,22 @@
|
|
1
|
+
Copyright (c) 2015 Jeremy Woertink
|
2
|
+
|
3
|
+
MIT License
|
4
|
+
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining
|
6
|
+
a copy of this software and associated documentation files (the
|
7
|
+
"Software"), to deal in the Software without restriction, including
|
8
|
+
without limitation the rights to use, copy, modify, merge, publish,
|
9
|
+
distribute, sublicense, and/or sell copies of the Software, and to
|
10
|
+
permit persons to whom the Software is furnished to do so, subject to
|
11
|
+
the following conditions:
|
12
|
+
|
13
|
+
The above copyright notice and this permission notice shall be
|
14
|
+
included in all copies or substantial portions of the Software.
|
15
|
+
|
16
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
|
17
|
+
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
18
|
+
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
|
19
|
+
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
|
20
|
+
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
|
21
|
+
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
|
22
|
+
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
|
data/README.md
ADDED
@@ -0,0 +1,59 @@
|
|
1
|
+
# EnomRuby
|
2
|
+
|
3
|
+
A ruby wrapper for the [Enom Reseller](http://www.enom.com/resellers/api-documentation.aspx) API
|
4
|
+
|
5
|
+
## Installation
|
6
|
+
|
7
|
+
Add this line to your application's Gemfile:
|
8
|
+
|
9
|
+
```ruby
|
10
|
+
gem 'enom-ruby'
|
11
|
+
```
|
12
|
+
|
13
|
+
And then execute:
|
14
|
+
|
15
|
+
$ bundle
|
16
|
+
|
17
|
+
Or install it yourself as:
|
18
|
+
|
19
|
+
$ gem install enom-ruby
|
20
|
+
|
21
|
+
## Usage
|
22
|
+
|
23
|
+
```ruby
|
24
|
+
require 'enom-ruby'
|
25
|
+
|
26
|
+
EnomRuby::Client.configure do |c|
|
27
|
+
c.username = ENV['ENOM_USERNAME']
|
28
|
+
c.password = ENV['ENOM_PASSWORD']
|
29
|
+
c.test_mode = true
|
30
|
+
end
|
31
|
+
|
32
|
+
# searches for google.com
|
33
|
+
domains = EnomRuby::Domain.check('google')
|
34
|
+
|
35
|
+
# searches for google.co, google.org, google.net
|
36
|
+
domains = EnomRuby::Domain.check('google', ['co', 'org', 'net'])
|
37
|
+
|
38
|
+
domains.first.unavailable? #=> true
|
39
|
+
```
|
40
|
+
|
41
|
+
## Development
|
42
|
+
|
43
|
+
* Add a .env file `touch .env`
|
44
|
+
* Then add your `ENOM_USERNAME` and `ENOM_PASSWORD` environment variables.
|
45
|
+
* `rspec spec/` to run your tests.
|
46
|
+
|
47
|
+
Note that this needs to make an API call, so it will generate VCR cassettes.
|
48
|
+
|
49
|
+
## Contribute
|
50
|
+
|
51
|
+
1. Fork it ( https://github.com/[my-github-username]/enom-ruby/fork )
|
52
|
+
2. Create your feature branch (`git checkout -b my-new-feature`)
|
53
|
+
3. Commit your changes (`git commit -am 'Add some feature'`)
|
54
|
+
4. Push to the branch (`git push origin my-new-feature`)
|
55
|
+
5. Create a new Pull Request
|
56
|
+
|
57
|
+
## Mentions
|
58
|
+
|
59
|
+
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
ADDED
data/enom-ruby.gemspec
ADDED
@@ -0,0 +1,31 @@
|
|
1
|
+
# coding: utf-8
|
2
|
+
lib = File.expand_path('../lib', __FILE__)
|
3
|
+
$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
|
4
|
+
require 'enom-ruby/version'
|
5
|
+
|
6
|
+
Gem::Specification.new do |spec|
|
7
|
+
spec.name = "enom-ruby"
|
8
|
+
spec.version = EnomRuby::VERSION
|
9
|
+
spec.authors = ["Jeremy Woertink"]
|
10
|
+
spec.email = ["jeremywoertink@gmail.com"]
|
11
|
+
spec.summary = %q{Ruby wrapper for the Enom API}
|
12
|
+
spec.description = %q{EnomRuby is a Ruby wrapper for portions of the Enom domain reseller API.}
|
13
|
+
spec.homepage = "https://github.com/jwoertink/enom-ruby"
|
14
|
+
spec.license = "MIT"
|
15
|
+
|
16
|
+
spec.files = `git ls-files -z`.split("\x0")
|
17
|
+
spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
|
18
|
+
spec.test_files = spec.files.grep(%r{^(test|spec|features)/})
|
19
|
+
spec.require_paths = ["lib"]
|
20
|
+
|
21
|
+
spec.add_dependency "httparty", "0.13.3"
|
22
|
+
spec.add_dependency "hashie", "3.3.2"
|
23
|
+
|
24
|
+
spec.add_development_dependency "bundler", "~> 1.7"
|
25
|
+
spec.add_development_dependency "dotenv", "~> 1.0"
|
26
|
+
spec.add_development_dependency "pry", "~> 0.10"
|
27
|
+
spec.add_development_dependency "rake", "~> 10.0"
|
28
|
+
spec.add_development_dependency "rspec", "~> 3.1"
|
29
|
+
spec.add_development_dependency "vcr", "~> 2.9"
|
30
|
+
spec.add_development_dependency "webmock", "~> 1.20"
|
31
|
+
end
|
data/lib/enom-ruby.rb
ADDED
@@ -0,0 +1,42 @@
|
|
1
|
+
require 'httparty'
|
2
|
+
|
3
|
+
module EnomRuby
|
4
|
+
|
5
|
+
class Client
|
6
|
+
include HTTParty
|
7
|
+
|
8
|
+
class << self
|
9
|
+
attr_accessor :username, :password, :test_mode
|
10
|
+
alias_method :test?, :test_mode
|
11
|
+
|
12
|
+
def configure
|
13
|
+
yield self
|
14
|
+
end
|
15
|
+
|
16
|
+
# All requests must contain the UID, PW, and ResponseType query parameters
|
17
|
+
def default_params
|
18
|
+
{ "UID" => self.username, "PW" => self.password, "ResponseType" => "xml" }
|
19
|
+
end
|
20
|
+
|
21
|
+
# Enom has a test platform and a production platform. Both are configured to use
|
22
|
+
# HTTPS at all times. Don't forget to configure permitted IPs (in both environments)
|
23
|
+
# or you'll get InterfaceErrors.
|
24
|
+
def base_uri
|
25
|
+
subdomain = test? ? 'resellertest' : 'reseller'
|
26
|
+
"https://#{subdomain}.enom.com/interface.asp"
|
27
|
+
end
|
28
|
+
|
29
|
+
# All requests to Enom are GET requests, even when we're changing data. Unfortunately,
|
30
|
+
# Enom also does not provide HTTP status codes to alert for authentication failures
|
31
|
+
# or other helpful statuses -- everything comes back as a 200.
|
32
|
+
def request(params = {})
|
33
|
+
response = get(base_uri, query: params.merge(default_params))
|
34
|
+
if Integer(response["interface_response"]["ErrCount"]).zero?
|
35
|
+
return response["interface_response"]
|
36
|
+
else
|
37
|
+
raise InterfaceError, response["interface_response"]["errors"].values.join(", ")
|
38
|
+
end
|
39
|
+
end
|
40
|
+
end
|
41
|
+
end
|
42
|
+
end
|
@@ -0,0 +1,34 @@
|
|
1
|
+
require 'hashie/mash'
|
2
|
+
|
3
|
+
module EnomRuby
|
4
|
+
|
5
|
+
class Domain
|
6
|
+
DEFAULT_TLDS = ['com']
|
7
|
+
|
8
|
+
def self.check(sld, tld_list = DEFAULT_TLDS)
|
9
|
+
response = Client.request(command: 'Check', sld: sld, tldlist: tld_list.join(','))
|
10
|
+
domains = Hash[*Array(response['Domain']).zip(Array(response['RRPText'])).flatten]
|
11
|
+
[].tap do |results|
|
12
|
+
domains.each_pair { |domain, text| results << new(domain, text) }
|
13
|
+
end
|
14
|
+
end
|
15
|
+
|
16
|
+
def initialize(domain, availability_text)
|
17
|
+
@domain = domain
|
18
|
+
@availability_text = availability_text
|
19
|
+
end
|
20
|
+
|
21
|
+
def available?
|
22
|
+
@availability_text == 'Domain available'
|
23
|
+
end
|
24
|
+
|
25
|
+
def unavailable?
|
26
|
+
not available?
|
27
|
+
end
|
28
|
+
|
29
|
+
def url
|
30
|
+
@domain
|
31
|
+
end
|
32
|
+
|
33
|
+
end
|
34
|
+
end
|
data/spec/client_spec.rb
ADDED
@@ -0,0 +1,21 @@
|
|
1
|
+
require_relative 'spec_helper'
|
2
|
+
|
3
|
+
RSpec.describe EnomRuby::Client do
|
4
|
+
|
5
|
+
describe '.base_uri' do
|
6
|
+
|
7
|
+
it 'returns the enom test domain when set to test' do
|
8
|
+
expect(EnomRuby::Client.base_uri).to eq "https://resellertest.enom.com/interface.asp"
|
9
|
+
end
|
10
|
+
|
11
|
+
context 'when in production mode' do
|
12
|
+
before { EnomRuby::Client.test_mode = false }
|
13
|
+
after { EnomRuby::Client.test_mode = true }
|
14
|
+
|
15
|
+
it 'returns the enom production domain when test it set to false' do
|
16
|
+
expect(EnomRuby::Client.base_uri).to eq "https://reseller.enom.com/interface.asp"
|
17
|
+
end
|
18
|
+
end
|
19
|
+
end
|
20
|
+
|
21
|
+
end
|
data/spec/domain_spec.rb
ADDED
@@ -0,0 +1,17 @@
|
|
1
|
+
require_relative 'spec_helper'
|
2
|
+
|
3
|
+
RSpec.describe EnomRuby::Domain do
|
4
|
+
|
5
|
+
describe '.check', vcr: true do
|
6
|
+
|
7
|
+
context 'with a valid SLD "google" and no extra TLDs' do
|
8
|
+
it 'returns an array with a single domain object showing unavailable' do
|
9
|
+
domain = EnomRuby::Domain.check('google').first
|
10
|
+
expect(domain).to be_a(EnomRuby::Domain)
|
11
|
+
expect(domain).to be_unavailable
|
12
|
+
expect(domain.url).to eq 'google.com'
|
13
|
+
end
|
14
|
+
end
|
15
|
+
end
|
16
|
+
|
17
|
+
end
|
data/spec/spec_helper.rb
ADDED
@@ -0,0 +1,33 @@
|
|
1
|
+
require 'rspec'
|
2
|
+
require 'vcr'
|
3
|
+
require 'pry'
|
4
|
+
require 'dotenv'
|
5
|
+
Dotenv.load
|
6
|
+
|
7
|
+
$: << File.expand_path('../lib', __FILE__)
|
8
|
+
require 'enom-ruby'
|
9
|
+
|
10
|
+
real_requests = ENV['REAL_REQUESTS']
|
11
|
+
|
12
|
+
VCR.configure do |config|
|
13
|
+
config.cassette_library_dir = "spec/cassettes"
|
14
|
+
config.hook_into :webmock
|
15
|
+
config.configure_rspec_metadata!
|
16
|
+
config.allow_http_connections_when_no_cassette = true if real_requests
|
17
|
+
config.default_cassette_options = {record: :new_episodes}
|
18
|
+
end
|
19
|
+
|
20
|
+
RSpec.configure do |config|
|
21
|
+
config.filter_run focus: true
|
22
|
+
config.run_all_when_everything_filtered = true
|
23
|
+
config.color = true
|
24
|
+
config.before(:each) {
|
25
|
+
VCR.eject_cassette
|
26
|
+
} if real_requests
|
27
|
+
end
|
28
|
+
|
29
|
+
EnomRuby::Client.configure do |config|
|
30
|
+
config.username = ENV['ENOM_USERNAME']
|
31
|
+
config.password = ENV['ENOM_PASSWORD']
|
32
|
+
config.test_mode = true
|
33
|
+
end
|
metadata
ADDED
@@ -0,0 +1,189 @@
|
|
1
|
+
--- !ruby/object:Gem::Specification
|
2
|
+
name: enom-ruby
|
3
|
+
version: !ruby/object:Gem::Version
|
4
|
+
version: 0.1.0
|
5
|
+
platform: ruby
|
6
|
+
authors:
|
7
|
+
- Jeremy Woertink
|
8
|
+
autorequire:
|
9
|
+
bindir: bin
|
10
|
+
cert_chain: []
|
11
|
+
date: 2015-02-02 00:00:00.000000000 Z
|
12
|
+
dependencies:
|
13
|
+
- !ruby/object:Gem::Dependency
|
14
|
+
name: httparty
|
15
|
+
requirement: !ruby/object:Gem::Requirement
|
16
|
+
requirements:
|
17
|
+
- - '='
|
18
|
+
- !ruby/object:Gem::Version
|
19
|
+
version: 0.13.3
|
20
|
+
type: :runtime
|
21
|
+
prerelease: false
|
22
|
+
version_requirements: !ruby/object:Gem::Requirement
|
23
|
+
requirements:
|
24
|
+
- - '='
|
25
|
+
- !ruby/object:Gem::Version
|
26
|
+
version: 0.13.3
|
27
|
+
- !ruby/object:Gem::Dependency
|
28
|
+
name: hashie
|
29
|
+
requirement: !ruby/object:Gem::Requirement
|
30
|
+
requirements:
|
31
|
+
- - '='
|
32
|
+
- !ruby/object:Gem::Version
|
33
|
+
version: 3.3.2
|
34
|
+
type: :runtime
|
35
|
+
prerelease: false
|
36
|
+
version_requirements: !ruby/object:Gem::Requirement
|
37
|
+
requirements:
|
38
|
+
- - '='
|
39
|
+
- !ruby/object:Gem::Version
|
40
|
+
version: 3.3.2
|
41
|
+
- !ruby/object:Gem::Dependency
|
42
|
+
name: bundler
|
43
|
+
requirement: !ruby/object:Gem::Requirement
|
44
|
+
requirements:
|
45
|
+
- - "~>"
|
46
|
+
- !ruby/object:Gem::Version
|
47
|
+
version: '1.7'
|
48
|
+
type: :development
|
49
|
+
prerelease: false
|
50
|
+
version_requirements: !ruby/object:Gem::Requirement
|
51
|
+
requirements:
|
52
|
+
- - "~>"
|
53
|
+
- !ruby/object:Gem::Version
|
54
|
+
version: '1.7'
|
55
|
+
- !ruby/object:Gem::Dependency
|
56
|
+
name: dotenv
|
57
|
+
requirement: !ruby/object:Gem::Requirement
|
58
|
+
requirements:
|
59
|
+
- - "~>"
|
60
|
+
- !ruby/object:Gem::Version
|
61
|
+
version: '1.0'
|
62
|
+
type: :development
|
63
|
+
prerelease: false
|
64
|
+
version_requirements: !ruby/object:Gem::Requirement
|
65
|
+
requirements:
|
66
|
+
- - "~>"
|
67
|
+
- !ruby/object:Gem::Version
|
68
|
+
version: '1.0'
|
69
|
+
- !ruby/object:Gem::Dependency
|
70
|
+
name: pry
|
71
|
+
requirement: !ruby/object:Gem::Requirement
|
72
|
+
requirements:
|
73
|
+
- - "~>"
|
74
|
+
- !ruby/object:Gem::Version
|
75
|
+
version: '0.10'
|
76
|
+
type: :development
|
77
|
+
prerelease: false
|
78
|
+
version_requirements: !ruby/object:Gem::Requirement
|
79
|
+
requirements:
|
80
|
+
- - "~>"
|
81
|
+
- !ruby/object:Gem::Version
|
82
|
+
version: '0.10'
|
83
|
+
- !ruby/object:Gem::Dependency
|
84
|
+
name: rake
|
85
|
+
requirement: !ruby/object:Gem::Requirement
|
86
|
+
requirements:
|
87
|
+
- - "~>"
|
88
|
+
- !ruby/object:Gem::Version
|
89
|
+
version: '10.0'
|
90
|
+
type: :development
|
91
|
+
prerelease: false
|
92
|
+
version_requirements: !ruby/object:Gem::Requirement
|
93
|
+
requirements:
|
94
|
+
- - "~>"
|
95
|
+
- !ruby/object:Gem::Version
|
96
|
+
version: '10.0'
|
97
|
+
- !ruby/object:Gem::Dependency
|
98
|
+
name: rspec
|
99
|
+
requirement: !ruby/object:Gem::Requirement
|
100
|
+
requirements:
|
101
|
+
- - "~>"
|
102
|
+
- !ruby/object:Gem::Version
|
103
|
+
version: '3.1'
|
104
|
+
type: :development
|
105
|
+
prerelease: false
|
106
|
+
version_requirements: !ruby/object:Gem::Requirement
|
107
|
+
requirements:
|
108
|
+
- - "~>"
|
109
|
+
- !ruby/object:Gem::Version
|
110
|
+
version: '3.1'
|
111
|
+
- !ruby/object:Gem::Dependency
|
112
|
+
name: vcr
|
113
|
+
requirement: !ruby/object:Gem::Requirement
|
114
|
+
requirements:
|
115
|
+
- - "~>"
|
116
|
+
- !ruby/object:Gem::Version
|
117
|
+
version: '2.9'
|
118
|
+
type: :development
|
119
|
+
prerelease: false
|
120
|
+
version_requirements: !ruby/object:Gem::Requirement
|
121
|
+
requirements:
|
122
|
+
- - "~>"
|
123
|
+
- !ruby/object:Gem::Version
|
124
|
+
version: '2.9'
|
125
|
+
- !ruby/object:Gem::Dependency
|
126
|
+
name: webmock
|
127
|
+
requirement: !ruby/object:Gem::Requirement
|
128
|
+
requirements:
|
129
|
+
- - "~>"
|
130
|
+
- !ruby/object:Gem::Version
|
131
|
+
version: '1.20'
|
132
|
+
type: :development
|
133
|
+
prerelease: false
|
134
|
+
version_requirements: !ruby/object:Gem::Requirement
|
135
|
+
requirements:
|
136
|
+
- - "~>"
|
137
|
+
- !ruby/object:Gem::Version
|
138
|
+
version: '1.20'
|
139
|
+
description: EnomRuby is a Ruby wrapper for portions of the Enom domain reseller API.
|
140
|
+
email:
|
141
|
+
- jeremywoertink@gmail.com
|
142
|
+
executables: []
|
143
|
+
extensions: []
|
144
|
+
extra_rdoc_files: []
|
145
|
+
files:
|
146
|
+
- ".gitignore"
|
147
|
+
- ".ruby-version"
|
148
|
+
- Gemfile
|
149
|
+
- LICENSE.txt
|
150
|
+
- README.md
|
151
|
+
- Rakefile
|
152
|
+
- enom-ruby.gemspec
|
153
|
+
- lib/enom-ruby.rb
|
154
|
+
- lib/enom-ruby/client.rb
|
155
|
+
- lib/enom-ruby/domain.rb
|
156
|
+
- lib/enom-ruby/version.rb
|
157
|
+
- spec/cassettes/.keep
|
158
|
+
- spec/client_spec.rb
|
159
|
+
- spec/domain_spec.rb
|
160
|
+
- spec/spec_helper.rb
|
161
|
+
homepage: https://github.com/jwoertink/enom-ruby
|
162
|
+
licenses:
|
163
|
+
- MIT
|
164
|
+
metadata: {}
|
165
|
+
post_install_message:
|
166
|
+
rdoc_options: []
|
167
|
+
require_paths:
|
168
|
+
- lib
|
169
|
+
required_ruby_version: !ruby/object:Gem::Requirement
|
170
|
+
requirements:
|
171
|
+
- - ">="
|
172
|
+
- !ruby/object:Gem::Version
|
173
|
+
version: '0'
|
174
|
+
required_rubygems_version: !ruby/object:Gem::Requirement
|
175
|
+
requirements:
|
176
|
+
- - ">="
|
177
|
+
- !ruby/object:Gem::Version
|
178
|
+
version: '0'
|
179
|
+
requirements: []
|
180
|
+
rubyforge_project:
|
181
|
+
rubygems_version: 2.4.3
|
182
|
+
signing_key:
|
183
|
+
specification_version: 4
|
184
|
+
summary: Ruby wrapper for the Enom API
|
185
|
+
test_files:
|
186
|
+
- spec/cassettes/.keep
|
187
|
+
- spec/client_spec.rb
|
188
|
+
- spec/domain_spec.rb
|
189
|
+
- spec/spec_helper.rb
|