dnsimpler 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e55d0899d0aba7fa5de9ae93c0ce236ae0638d0c
+  data.tar.gz: ad731d225b710cf02f4e972f3b3ffd70d8af8adf
+SHA512:
+  metadata.gz: 7fe6d9c382f0cfdf5f67f7eee0984c3ce7f847d4c0ecb933e0fff2c37a861cdf4a7d900f8a0e56404ad8d363cc4f1feb505eac09600c815656124c0bfec3046f
+  data.tar.gz: 7c88d152dfd412c80ca7f36df6f82a80147b6a28cc106485ce85277096018a2e780b98cab619d12850994555b3c64ac137f2eec8ac9a805c4b27a459e1b7387f

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,12 @@
+language: ruby
+rvm:
+  - "2.2.0"
+script:
+  - bundle exec rake test
+deploy:
+  provider: rubygems
+  api_key:
+    secure: F1Drh/pkUEDBvn0l6ZpFJeCeJk0FGReu98Ce3PMiIHjHngGsC3xDOTbkQ7+TUQHlfc0g3Hpc4pYmHxL3w/6TJwbx9csRX0Np4yaNfJZJdHR8uzAi7mpY32APXeLCJkV5En3h1B/G1V3qQ+AhH0Ez6nlOiSEhocJ+MVq9jFXagM4=
+addons:
+  code_climate:
+    repo_token: 4ee7d32ad4a19408aa4c0d5846e6451a05635e4c1a31109cb0eac9d3a2efa265

data/Gemfile

@@ -0,0 +1,12 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in dnsimpler.gemspec
+gemspec
+
+group :development do
+  gem 'minitest'
+  gem 'guard', "2.10.0"
+  gem 'guard-minitest'
+end
+
+gem "codeclimate-test-reporter", group: :test, require: nil

data/Guardfile

@@ -0,0 +1,6 @@
+guard :minitest do
+  # with Minitest::Unit
+  watch(%r{^test/(.*)\/?(.*)_test\.rb$})
+  watch(%r{^lib/(.*/)?([^/]+)\.rb$})     { |m| "test/#{m[1]}#{m[2]}_test.rb" }
+  watch(%r{^test/test_helper\.rb$})      { 'test' }
+end

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 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,59 @@
+# Dnsimpler
+[![TravisCI](https://travis-ci.org/danielwestendorf/dnsimpler.svg)](https://travis-ci.org/danielwestendorf/dnsimpler)[![Code Climate](https://codeclimate.com/github/danielwestendorf/dnsimpler/badges/gpa.svg)](https://codeclimate.com/github/danielwestendorf/dnsimpler)[![Test Coverage](https://codeclimate.com/github/danielwestendorf/dnsimpler/badges/coverage.svg)](https://codeclimate.com/github/danielwestendorf/dnsimpler)
+
+A simple API wrapper for [DNSimple](https://dnsimple.com). Always returns the full response. Requires you to use the [API documentation](https://developer.dnsimple.com).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'dnsimpler'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dnsimpler
+
+## Usage
+
+Configure the gem
+```ruby
+DNSimpler.setup do |config|
+    config.username = "bob@example.com"
+    config.token = "DNSIMPLE_API_TOKEN"
+    config.base_uri = "https://api.dnsimple.com" # For testing you can use the sandbox
+    config.debug = false
+    config.proxy = {addr: 'http://example.com', port: 8080, user: 'bob', pass: 'password'}
+end
+```
+
+Make your API calls.
+```ruby
+domains_response = DNSimpler.get('v1/domains')
+p domains_response.code
+=> 200
+p domains_response.body
+[ { domain: { ... } }, { domain: { ... } } ]
+```
+
+Some API calls require parameters. Just pass them as a hash
+```ruby
+registration = DNSimpler.post('v1/domain_registrations', domain: {name: 'example.com', registrant_id: 1234})
+p registration.code
+=> 201
+p domains_response.body
+{ domain: { name: 'example.com', .... } }
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/dnsimpler/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,12 @@
+require "bundler/gem_tasks"
+
+require "rake/testtask"
+
+task :default => :test
+
+Rake::TestTask.new do |t|
+  t.libs << "lib"
+  t.libs << "test"
+  t.test_files = FileList["test/**/*_test.rb"]
+  t.verbose = true
+end

data/dnsimpler.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dnsimpler/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dnsimpler"
+  spec.version       = DNSimpler::VERSION
+  spec.authors       = ["Daniel Westendorf"]
+  spec.email         = ["daniel@prowestech.com"]
+  spec.summary       = %q{A simple DNSimple API wrapper that always provides the response you're looking for.}
+  spec.description   = %q{dnsimple-ruby is too opinionated on how to use its method calls. We're all capable devs, righ? Let's just use the API like a developer would.}
+  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.required_ruby_version  = "~> 2.0"
+
+  spec.add_runtime_dependency "httparty"
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock"
+end

data/lib/dnsimpler.rb

@@ -0,0 +1,62 @@
+require 'ostruct'
+require "dnsimpler/version"
+require 'dnsimpler/http'
+
+module DNSimpler
+  MATTRS = %w[username token base_uri debug]
+
+  MATTRS.each do |mattr|
+    module_eval <<-RUBY_EVAL, __FILE__, __LINE__
+      def self.#{mattr}; return @@#{mattr}; end;
+      def self.#{mattr}=(attr); @@#{mattr} = attr; end;
+    RUBY_EVAL
+  end
+
+  # Debuggin is off by default
+  @@debug = false
+
+  # API username
+  @@username = ''
+
+  # API token
+  @@token = ''
+
+  # URI for the requests. Defaults to https://api.dnsimple.com/
+  @@base_uri = 'https://api.dnsimple.com/'
+
+  # http proxy info. Should be a hash {addr: 'http://example.com', port: 8080, user: 'bob', pass: 'ed'}
+  @@http_proxy = nil
+
+  def self.http_proxy=(opts)
+    @@http_proxy = OpenStruct.new(opts)
+  end
+
+  def self.http_proxy
+    @@http_proxy
+  end
+
+  # Allow configuring Dnsimpler with a block
+  #
+  # Example:
+  #
+  #     Dnsimpler.setup do |config|
+  #       config.username = 'bob@example.com'
+  #       config.token    = '1234'
+  #       ....
+  #     end
+  def self.setup
+    yield self
+  end
+
+  # Delegate the class methods to the HTTP class
+  %w[get post head delete patch put].each do |method|
+    module_eval <<-RUBY_EVAL, __FILE__, __LINE__
+
+      def self.#{method}(path, options = {}, &blk)
+        HTTP.#{method}(path, options, &blk)
+      end
+
+    RUBY_EVAL
+  end
+
+end

data/lib/dnsimpler/http.rb

@@ -0,0 +1,55 @@
+require 'httparty'
+
+module DNSimpler
+  class HTTP
+    include HTTParty
+
+    def self.base_options
+      opts = {
+        base_uri: DNSimpler.base_uri,
+        format: :json,
+        headers: {
+          'Accept' => 'application/json',
+          'User-Agent' => "dnsimpler/#{DNSimpler::VERSION}",
+          'X-DNSimple-Token' => "#{DNSimpler.username}:#{DNSimpler.token}"
+        }
+      }
+
+      unless DNSimpler.http_proxy.nil?
+        proxy = DNSimpler.http_proxy
+        opts[:http_proxy_addr] = proxy[:addr]
+        opts[:http_proxy_port] = proxy[:port]
+        opts[:http_proxy_user] = proxy[:user]
+        opts[:http_proxy_pass] = proxy[:pass]
+      end
+
+      puts "Base Options: #{opts}" if DNSimpler.debug
+
+      return opts
+    end
+
+    %w[get post head delete patch put].each do |method|
+      class_eval <<-RUBY_EVAL, __FILE__, __LINE__
+
+        def self.#{method}(path, opts = {}, &blk)
+          opts = {body: opts}
+          opts.merge!(self.base_options)
+
+          req = super path, opts, &blk
+
+          response = OpenStruct.new(code: req.code, body: req.parsed_response)
+
+          if DNSimpler.debug
+            response.request = req
+
+            puts "Request Options: " + opts.to_s
+          end
+
+          return response
+        end
+
+      RUBY_EVAL
+    end
+
+  end
+end

data/lib/dnsimpler/version.rb

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

data/test/dnsimpler/http_test.rb

@@ -0,0 +1,21 @@
+require 'test_helper'
+
+module DNSimpler
+  class HTTPTest < MiniTest::Test
+
+    test "#base_options" do
+      assert_instance_of Hash, HTTP.base_options
+    end
+
+    %w[get post head delete patch put].each do |method|
+      class_eval <<-RUBY_EVAL
+
+        test "#{method}" do
+          response = HTTP.#{method}('v1/domains')
+          assert_instance_of OpenStruct, response
+        end
+
+      RUBY_EVAL
+    end
+  end
+end

data/test/dnsimpler_test.rb

@@ -0,0 +1,54 @@
+require 'test_helper'
+
+class DNSimplerTest < MiniTest::Test
+  CONFIGS = %w[username token base_uri debug]
+
+  CONFIGS.each do |config|
+    class_eval <<-RUBY_EVAL, __FILE__, __LINE__
+      test "##{config}" do
+        refute_nil DNSimpler.#{config}
+      end
+
+      test "##{config}=" do
+        refute_nil DNSimpler.#{config}= 'test-string'
+      end
+
+      test "##{config}= in setup block" do
+        DNSimpler.setup do |config|
+          config.#{config} = "#{config}-test-string"
+        end
+
+        assert DNSimpler.#{config}, "#{config}-test-string"
+      end
+    RUBY_EVAL
+  end
+
+  %w[get post head delete patch put].each do |method|
+    class_eval <<-RUBY_EVAL
+
+    test "#{method}" do
+      response = DNSimpler.#{method}('v1/domains')
+      assert_instance_of OpenStruct, response
+    end
+
+    RUBY_EVAL
+  end
+
+  test "invalid config variable" do
+    assert_raises NoMethodError do
+      DNSimpler.nonconfig = 'bob'
+    end
+
+    assert_raises NoMethodError do
+      DNSimpler.setup do |config|
+        config.fake = 'ed'
+      end
+    end
+  end
+
+  test "#{}http_proxy" do
+    DNSimpler.http_proxy = {addr: 'http://example.com', port: 8080, user: 'bob', pass: 'password'}
+    assert_instance_of OpenStruct, DNSimpler.http_proxy
+  end
+
+end

data/test/test_helper.rb

@@ -0,0 +1,35 @@
+require "codeclimate-test-reporter"
+CodeClimate::TestReporter.start
+
+require "minitest/autorun"
+require 'dnsimpler'
+require 'webmock/minitest'
+
+class MiniTest::Test
+
+  def setup
+    DNSimpler.setup do |config|
+      config.base_uri = "https://api.sandbox.dnsimple.com/"
+      config.http_proxy = nil
+      config.debug = false
+    end
+
+    WebMock.disable_net_connect!(allow: "codeclimate.com")
+    stub_request(:any, "#{DNSimpler.base_uri}v1/domains").to_return(status: 200, body: [{domain: {id: 707}}, {domain: {id: 708}}].to_json)
+  end
+
+  # Stolen from rails source cause I like the syntax
+  def self.test(name, &block)
+    test_name = "test_#{name.gsub(/\s+/,'_')}".to_sym
+    defined = method_defined? test_name
+    raise "#{test_name} is already defined in #{self}" if defined
+    if block_given?
+      define_method(test_name, &block)
+    else
+      define_method(test_name) do
+        flunk "No implementation provided for #{name}"
+      end
+    end
+  end
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: dnsimpler
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Daniel Westendorf
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-01-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: webmock
+  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: dnsimple-ruby is too opinionated on how to use its method calls. We're
+  all capable devs, righ? Let's just use the API like a developer would.
+email:
+- daniel@prowestech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- Guardfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- dnsimpler.gemspec
+- lib/dnsimpler.rb
+- lib/dnsimpler/http.rb
+- lib/dnsimpler/version.rb
+- test/dnsimpler/http_test.rb
+- test/dnsimpler_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: '2.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 simple DNSimple API wrapper that always provides the response you're looking
+  for.
+test_files:
+- test/dnsimpler/http_test.rb
+- test/dnsimpler_test.rb
+- test/test_helper.rb