namecheap-api 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6f3e6c5354ca711a0be049e0f04035d0ce5f3665
+  data.tar.gz: 350d6beb49e34135e0928cc8330ddad7ffce0f2c
+SHA512:
+  metadata.gz: 4723560bd15d2cc458fe3a689e89aca9041bcc88f62f8714d24142f41e4ad51ecbafd21c3e67da207e0c3723ad6bbf134713bb1101ed18d8df65ea96813aa422
+  data.tar.gz: 708d2ef7e89e5175c84673f50ea0f92b496af92bd4a71f734793d5382a10ffc7160d58fb15d44b2e6739e794af788d8a0976ae463d184d2ee9b23623aaca3ebe

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Patrick Ma
+
+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,53 @@
+# NamecheapApi
+
+a Ruby gem for working with the Namecheap API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'namecheap-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install namecheap-api --pre
+
+## Usage
+
+In Gemfile:
+
+```ruby
+gem 'namecheap-api'
+```
+
+Example:
+
+```ruby
+require 'namecheap-api'
+
+config = {
+  sandbox: true,
+  client_ip: 'xxx.xxx.xxx.xxx',
+  api_username: '<insert username>',
+  username: '<insert password>',
+  api_key: '<insert api key>'
+}
+
+client = NamecheapApi::Client.new(config)
+
+client.call('namecheap.domains.check', :DomainList => 'domain1.com,domain2.com')
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/PatrickMa/namecheap/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

data/Rakefile

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

data/lib/namecheap_api.rb

@@ -0,0 +1,7 @@
+require "namecheap_api/version"
+require "namecheap_api/response"
+require "namecheap_api/request"
+require "namecheap_api/client"
+
+module NamecheapApi
+end

data/lib/namecheap_api/client.rb

@@ -0,0 +1,29 @@
+module NamecheapApi
+  ENDPOINTS = {
+    sandbox: 'https://api.sandbox.namecheap.com/xml.response',
+    production: 'https://api.namecheap.com/xml.response'
+  }
+
+  class Client
+    attr_reader :config
+
+    def initialize(config)
+      @config = config
+      @sandbox = config[:sandbox]
+    end
+
+    def call(command, parameters = {})
+      Response.new(new_request(command, parameters).call.body)
+    end
+
+    def endpoint
+      @sandbox ? ENDPOINTS[:sandbox] : ENDPOINTS[:production]
+    end
+
+    private
+
+    def new_request(command, parameters)
+      Request.new(self, command, parameters)
+    end
+  end
+end

data/lib/namecheap_api/request.rb

@@ -0,0 +1,33 @@
+require 'typhoeus'
+
+module NamecheapApi
+  class Request
+    def initialize(client, command, command_parameters = {})
+      @client = client
+      @command = command
+      @command_parameters = command_parameters
+    end
+
+    def call
+      request.run
+    end
+    
+    def request
+      request = Typhoeus::Request.new(@client.endpoint, params: request_parameters)
+    end
+
+    def request_parameters
+      {
+        :ApiUser => config[:api_username],
+        :ApiKey => config[:api_key],
+        :UserName => config[:username],
+        :ClientIp => config[:client_ip],
+        :Command => @command
+      }.merge(@command_parameters)
+    end
+
+    def config
+      @client.config
+    end
+  end
+end

data/lib/namecheap_api/response.rb

@@ -0,0 +1,37 @@
+require 'nokogiri'
+
+module NamecheapApi
+  class Response
+    attr_accessor :raw_body
+
+    def initialize(body)
+      @raw_body = body
+    end
+
+    def command
+      doc.css('RequestedCommand').text
+    end
+
+    def results
+      doc.css('CommandResponse > *').map do |result|
+        clean_hash_keys(result.to_h)
+      end
+    end
+
+    def doc
+      @doc ||= Nokogiri::XML(raw_body)
+    end
+
+    private
+
+    def clean_hash_keys(hash)
+      hash.map do |key, value|
+        clean_key = key
+          .gsub(/(?:([A-Za-z\d])|^)()(?=\b|[^a-z])/) { "#{$1}#{$1 && '_'}#{$2.downcase}" }
+          .chop
+          .downcase.to_sym
+        { clean_key => value }
+      end.inject(:merge)
+    end
+  end
+end

data/lib/namecheap_api/version.rb

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

data/namecheap_api.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'namecheap_api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "namecheap-api"
+  spec.version       = NamecheapApi::VERSION
+  spec.authors       = ["Patrick Ma"]
+  spec.email         = ["fivetwentysix@gmail.com"]
+  spec.summary       = "a Gem for interacting with the Namecheap API"
+  # spec.description   = %q{TODO: Write a longer description. Optional.}
+  spec.homepage      = "https://github.com/PatrickMa/namecheap-api"
+  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{^(spec)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.1"
+  spec.add_development_dependency "pry", "~> 0.10"
+  spec.add_dependency "typhoeus", "~> 0.6"
+  spec.add_dependency "nokogiri", "~> 1.6"
+end

data/spec/fixtures/namecheap_domains_check.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="utf-8"?>
+<ApiResponse Status="OK" xmlns="http://api.namecheap.com/xml.response">
+  <Errors />
+  <Warnings />
+  <RequestedCommand>namecheap.domains.check</RequestedCommand>
+  <CommandResponse Type="namecheap.domains.check">
+    <DomainCheckResult Domain="domain1.com" Available="false" ErrorNo="0" Description="" />
+    <DomainCheckResult Domain="domain2.com" Available="false" ErrorNo="0" Description="" />
+  </CommandResponse>
+  <Server>WEB1-SANDBOX1</Server>
+  <GMTTimeDifference>--5:00</GMTTimeDifference>
+  <ExecutionTime>1.21</ExecutionTime>
+</ApiResponse>

data/spec/lib/namecheap_api/client_spec.rb

@@ -0,0 +1,15 @@
+require 'namecheap_api/client'
+
+describe NamecheapApi::Client do
+  describe '#endpoint' do
+    it 'returns sandbox endpoint if sandbox' do
+      client = NamecheapApi::Client.new(sandbox: true)
+      expect(client.endpoint).to eq(NamecheapApi::ENDPOINTS[:sandbox])
+    end
+
+    it 'returns production endpoint if not sandbox' do
+      client = NamecheapApi::Client.new(sandbox: false)
+      expect(client.endpoint).to eq(NamecheapApi::ENDPOINTS[:production])
+    end
+  end
+end

data/spec/lib/namecheap_api/request_spec.rb

@@ -0,0 +1,58 @@
+require 'namecheap_api/request'
+
+describe NamecheapApi::Request do
+  let(:config) do
+    {
+      api_username: 'tester',
+      api_key: 'sample api key',
+      username: 'tester_username',
+      client_ip: '127.0.0.1'
+    }
+  end
+  let(:client) { double('Client', config: config, endpoint: 'something.com') }
+  let(:params) { { param1: 'param1' } }
+  let(:request) { NamecheapApi::Request.new(client, 'example.command', params) }
+
+  describe '#request' do
+    it { expect(request.request).to be_a(Typhoeus::Request) }
+  end
+
+  describe '#call' do
+    it 'delegates to Typhoeus::Request#run' do
+      expect_any_instance_of(Typhoeus::Request).to receive(:run)
+      request.call
+    end
+  end
+
+  describe '#request_parameters' do
+    it "contains 'ApiUser' with config[:api_username] value" do
+      expect(request.request_parameters[:ApiUser]).to eq(config[:api_username])
+    end
+
+    it "contains 'ApiKey' with config[:api_key] value" do
+      expect(request.request_parameters[:ApiKey]).to eq(config[:api_key])
+    end
+
+    it "contains 'UserName' with config[:username] value" do
+      expect(request.request_parameters[:UserName]).to eq(config[:username])
+    end
+
+    it "contains 'Command' with command value" do
+      expect(request.request_parameters[:Command]).to eq('example.command')
+    end
+
+    it "contains 'ClientIp' with config[:client_ip] value" do
+      expect(request.request_parameters[:ClientIp]).to eq(config[:client_ip])
+    end
+
+    it "merges params with the request_parameters" do
+      expect(request.request_parameters[:param1]).to eq(params[:param1])
+    end
+  end
+
+  describe '#config' do
+    it 'delegates to client' do
+      expect(request.config).to eq(config)
+    end
+  end
+end

data/spec/lib/namecheap_api/response_spec.rb

@@ -0,0 +1,34 @@
+require 'namecheap_api/response'
+
+describe NamecheapApi::Response do
+  # See: spec/fixtures/namecheap_domains_check.xml
+  let(:body) { load_fixture('namecheap_domains_check') }
+
+  let(:response) { NamecheapApi::Response.new(body) }
+
+  describe '#initialize(body)' do
+    it 'assigns body to @raw_body' do
+      expect(response.raw_body).to eq(body)
+    end
+  end
+
+  describe '#command' do
+    it "returns value of 'RequestedCommand'" do
+      expect(response.command).to eq('namecheap.domains.check')
+    end
+  end
+
+  describe '#results' do
+    it 'returns a array of hashes' do
+      expectation = [
+        { domain: "domain1.com", available: "false", error_no: "0", description: "" },
+        { domain: "domain2.com", available: "false", error_no: "0", description: "" }
+      ]
+      expect(response.results).to eq(expectation)
+    end
+  end
+
+  describe '#doc' do
+    it { expect(response.doc).to be_a(Nokogiri::XML::Document) }
+  end
+end

data/spec/lib/namecheap_api_spec.rb

@@ -0,0 +1,17 @@
+require 'namecheap_api'
+
+describe NamecheapApi do
+  it 'can check the availability of domains' do
+    config = {
+      sandbox: true,
+      client_ip: 'xxx.xxx.xxx.xxx',
+      api_username: '<insert username>',
+      username: '<insert password>',
+      api_key: '<insert api key>'
+    }
+
+    client = NamecheapApi::Client.new(config)
+    response = client.call('namecheap.domains.check', :DomainList => 'domain1.com,domain2.com')
+    expect(response).to be_a(NamecheapApi::Response)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,100 @@
+# This file was generated by the `rspec --init` command. Conventionally, all
+# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
+# The generated `.rspec` file contains `--require spec_helper` which will cause this
+# file to always be loaded, without a need to explicitly require it in any files.
+#
+# Given that it is always loaded, you are encouraged to keep this file as
+# light-weight as possible. Requiring heavyweight dependencies from this file
+# will add to the boot time of your test suite on EVERY test run, even for an
+# individual file that may not need all of that loaded. Instead, consider making
+# a separate helper file that requires the additional dependencies and performs
+# the additional setup, and require it from the spec files that actually need it.
+#
+# The `.rspec` file also contains a few flags that are not defaults but that
+# users commonly want.
+#
+# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
+require 'pry'
+
+def fixtures_path
+  File.dirname(__FILE__) + '/fixtures'
+end
+
+def load_fixture(name, extension = '.xml')
+  path = fixtures_path + '/' + name + extension
+  File.open(path).read
+end
+
+RSpec.configure do |config|
+  # rspec-expectations config goes here. You can use an alternate
+  # assertion/expectation library such as wrong or the stdlib/minitest
+  # assertions if you prefer.
+  config.expect_with :rspec do |expectations|
+    # This option will default to `true` in RSpec 4. It makes the `description`
+    # and `failure_message` of custom matchers include text for helper methods
+    # defined using `chain`, e.g.:
+    # be_bigger_than(2).and_smaller_than(4).description
+    #   # => "be bigger than 2 and smaller than 4"
+    # ...rather than:
+    #   # => "be bigger than 2"
+    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
+  end
+
+  # rspec-mocks config goes here. You can use an alternate test double
+  # library (such as bogus or mocha) by changing the `mock_with` option here.
+  config.mock_with :rspec do |mocks|
+    # Prevents you from mocking or stubbing a method that does not exist on
+    # a real object. This is generally recommended, and will default to
+    # `true` in RSpec 4.
+    mocks.verify_partial_doubles = true
+  end
+
+# The settings below are suggested to provide a good initial experience
+# with RSpec, but feel free to customize to your heart's content.
+=begin
+  # These two settings work together to allow you to limit a spec run
+  # to individual examples or groups you care about by tagging them with
+  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
+  # get run.
+  config.filter_run :focus
+  config.run_all_when_everything_filtered = true
+
+  # Limits the available syntax to the non-monkey patched syntax that is recommended.
+  # For more details, see:
+  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
+  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
+  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
+  config.disable_monkey_patching!
+
+  # This setting enables warnings. It's recommended, but in some cases may
+  # be too noisy due to issues in dependencies.
+  config.warnings = true
+
+  # Many RSpec users commonly either run the entire suite or an individual
+  # file, and it's useful to allow more verbose output when running an
+  # individual spec file.
+  if config.files_to_run.one?
+    # Use the documentation formatter for detailed output,
+    # unless a formatter has already been configured
+    # (e.g. via a command-line flag).
+    config.default_formatter = 'doc'
+  end
+
+  # Print the 10 slowest examples and example groups at the
+  # end of the spec run, to help surface which specs are running
+  # particularly slow.
+  config.profile_examples = 10
+
+  # Run specs in random order to surface order dependencies. If you find an
+  # order dependency and want to debug it, you can fix the order by providing
+  # the seed, which is printed after each run.
+  #     --seed 1234
+  config.order = :random
+
+  # Seed global randomization in this process using the `--seed` CLI option.
+  # Setting this allows you to use `--seed` to deterministically reproduce
+  # test failures related to randomization by passing the same `--seed` value
+  # as the one that triggered the failure.
+  Kernel.srand config.seed
+=end
+end

metadata

@@ -0,0 +1,152 @@
+--- !ruby/object:Gem::Specification
+name: namecheap-api
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Patrick Ma
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-11-07 00:00:00.000000000 Z
+dependencies:
+- !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: 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: 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: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+description: 
+email:
+- fivetwentysix@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/namecheap_api.rb
+- lib/namecheap_api/client.rb
+- lib/namecheap_api/request.rb
+- lib/namecheap_api/response.rb
+- lib/namecheap_api/version.rb
+- namecheap_api.gemspec
+- spec/fixtures/namecheap_domains_check.xml
+- spec/lib/namecheap_api/client_spec.rb
+- spec/lib/namecheap_api/request_spec.rb
+- spec/lib/namecheap_api/response_spec.rb
+- spec/lib/namecheap_api_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/PatrickMa/namecheap-api
+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.2.2
+signing_key: 
+specification_version: 4
+summary: a Gem for interacting with the Namecheap API
+test_files:
+- spec/fixtures/namecheap_domains_check.xml
+- spec/lib/namecheap_api/client_spec.rb
+- spec/lib/namecheap_api/request_spec.rb
+- spec/lib/namecheap_api/response_spec.rb
+- spec/lib/namecheap_api_spec.rb
+- spec/spec_helper.rb