dnsimple-ruby 1.5.1 → 1.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1ad2f0f53848ebf458ce24ef1c93ffcc13987d20
-  data.tar.gz: 8dc6ab4a793415fa47675c1b32b98a9cdf8188e1
+  metadata.gz: 1b267eb164a957a976d1f52b1d1f6ffcdc17dd67
+  data.tar.gz: 266cfc430920141b41cf225a7a719c2acb26a804
 SHA512:
-  metadata.gz: 9047c85d1d90c5da44eacf36e79cd729e346efaed3defb34340bf482605d763bad9099ee2446af89787de2bb64149a51953f36bd61ae7d4743616f34a9d1a2eb
-  data.tar.gz: cde66935f2047f166573598bc7358d7785b659e0aedbec6693dda775186ed4418adba10b348b656e65a3eb889daf01ee90bafd399d247578377e331b48e880e1
+  metadata.gz: 5d467e058f14961a4468a4b2c77a8753427f19f60e9e2f536ed1683d75829de7a31c2eacc3e54924d393853bc26735edd6c228b077daabb25a407635fd53435a
+  data.tar.gz: 7b16c351b0203b5266813b5f46e2b736f6a5acfcea865a78867960006059a12e60901487f40a2a5565daa81e8486487b317f556c7598764428f9a8d30495b7b8

data/CHANGELOG.md

@@ -1,14 +1,18 @@
 # Changelog
 
-## Release 1.5.1
+#### Release 1.5.2
+
+- NEW: Provide a meaningful user-agent.
+
+#### Release 1.5.1
 
 - FIXED: Invalid base URI.
 
-## Release 1.5.0
+#### Release 1.5.0
 
 - CHANGED: Added support for versioned API (GH-33)
 
-## Release 1.4.0
+#### Release 1.4.0
 
 - CHANGED: Normalized exception handling. No more RuntimeError.
   In case of request error, the client raises RequestError, RecordExists or RecodNotFound

data/lib/dnsimple/client.rb

@@ -3,7 +3,7 @@ require 'yaml'
 module DNSimple
   class Client
 
-    API_BASE_URI = "https://api.dnsimple.com/"
+    DEFAULT_BASE_URI  = "https://api.dnsimple.com/"
 
 
     def self.debug?
@@ -42,7 +42,7 @@ module DNSimple
     #
     # @return [String] The qualified API base uri.
     def self.base_uri
-      @base_uri ||= API_BASE_URI.chomp("/")
+      @base_uri ||= DEFAULT_BASE_URI.chomp("/")
     end
 
     # Sets the qualified API base uri.
@@ -89,11 +89,11 @@ module DNSimple
       (@credentials_loaded ||= false) or (username and (password or api_token))
     end
 
-    def self.standard_options
+    def self.base_options
       options = {
-                  :format => :json,
-                  :headers => {'Accept' => 'application/json'},
-                }
+        :format => :json,
+        :headers => { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{DNSimple::VERSION}" },
+      }
 
       if http_proxy
         options.merge!(
@@ -103,7 +103,7 @@ module DNSimple
       end
 
       if password
-        options[:basic_auth] = {:username => username, :password => password}
+        options[:basic_auth] = { :username => username, :password => password }
       elsif api_token
         options[:headers]['X-DNSimple-Token'] = "#{username}:#{api_token}"
       else
@@ -130,8 +130,7 @@ module DNSimple
     end
 
     def self.request(method, path, options)
-      response = HTTParty.send(method, "#{base_uri}#{path}",
-        standard_options.merge(options))
+      response = HTTParty.send(method, "#{base_uri}#{path}", base_options.merge(options))
 
       if response.code == 401
         raise AuthenticationFailed

data/lib/dnsimple/version.rb

@@ -1,3 +1,3 @@
 module DNSimple
-  VERSION = '1.5.1'
+  VERSION = '1.5.2'
 end

data/spec/dnsimple/client_spec.rb

@@ -3,65 +3,87 @@ require 'spec_helper'
 describe DNSimple::Client do
 
   let(:klass) { described_class }
+  let(:response) { stub('response', :code => 200) }
 
-  before :each do
-    @_username  = DNSimple::Client.username
-    @_password  = DNSimple::Client.password
-    @_api_token = DNSimple::Client.api_token
-    @_base_uri  = DNSimple::Client.base_uri
+  before do
+    @_username  = described_class.username
+    @_password  = described_class.password
+    @_api_token = described_class.api_token
+    @_base_uri  = described_class.base_uri
   end
 
   after do
-    DNSimple::Client.username   = @_username
-    DNSimple::Client.password   = @_password
-    DNSimple::Client.api_token  = @_api_token
-    DNSimple::Client.base_uri   = @_base_uri
+    described_class.username   = @_username
+    described_class.password   = @_password
+    described_class.api_token  = @_api_token
+    described_class.base_uri   = @_base_uri
   end
 
   [:get, :post, :put, :delete].each do |method|
     describe ".#{method}" do
-      let(:response) { stub('response', :code => 200) }
+      it "delegates to .request" do
+        described_class.expects(:request).with(method, '/domains', { :foo => 'bar' })
+        described_class.send(method, '/domains', { :foo => 'bar' })
+      end
+    end
+  end
 
-      it "uses HTTP authentication if there's a password provided" do
-        DNSimple::Client.username   = 'user'
-        DNSimple::Client.password   = 'pass'
-        DNSimple::Client.api_token  = nil
-        DNSimple::Client.base_uri   = 'https://api.example.com/'
+  describe ".request" do
+    it "uses HTTP authentication if there's a password provided" do
+      described_class.username   = 'user'
+      described_class.password   = 'pass'
+      described_class.api_token  = nil
+      described_class.base_uri   = 'https://api.example.com/'
 
-        HTTParty.expects(method).
-          with('https://api.example.com/domains',
-            :format => :json, :headers => {'Accept' => 'application/json'},
-            :basic_auth => { :username => 'user', :password => 'pass'}).
-          returns(response)
+      HTTParty.expects(:get).
+        with('https://api.example.com/domains', has_entries(:basic_auth => { :username => 'user', :password => 'pass' })).
+        returns(response)
 
-        DNSimple::Client.send(method, '/domains')
-      end
+      described_class.request(:get, '/domains', {})
+    end
 
-      it "uses header authentication if there's an api token provided" do
-        DNSimple::Client.username   = 'user'
-        DNSimple::Client.password   = nil
-        DNSimple::Client.api_token  = 'token'
-        DNSimple::Client.base_uri   = 'https://api.example.com/'
+    it "uses header authentication if there's an api token provided" do
+      described_class.username   = 'user'
+      described_class.password   = nil
+      described_class.api_token  = 'token'
+      described_class.base_uri   = 'https://api.example.com/'
 
-        HTTParty.expects(method).
-          with('https://api.example.com/domains',
-            :format => :json, :headers => {'Accept' => 'application/json',
-            'X-DNSimple-Token' => 'user:token'}).
-          returns(response)
+      HTTParty.expects(:get).
+        with('https://api.example.com/domains', has_entries(:headers => has_entries({ 'X-DNSimple-Token' => 'user:token' }))).
+        returns(response)
 
-        DNSimple::Client.send(method, '/domains')
-      end
+      described_class.request(:get, '/domains', {})
+    end
 
-      it "raises an error if there's no password or api token provided" do
-        DNSimple::Client.username   = 'user'
-        DNSimple::Client.password   = nil
-        DNSimple::Client.api_token  = nil
-        DNSimple::Client.base_uri   = 'https://api.example.com/'
+    it "raises an error if there's no password or api token provided" do
+      described_class.username   = 'user'
+      described_class.password   = nil
+      described_class.api_token  = nil
+      described_class.base_uri   = 'https://api.example.com/'
 
-        lambda {
-          DNSimple::Client.send(method, '/domains')
-        }.should raise_error(DNSimple::Error, 'A password or API token is required for all API requests.')
-      end
+      expect {
+        described_class.request(:get, '/domains', {})
+      }.to raise_error(DNSimple::Error, 'A password or API token is required for all API requests.')
+    end
+
+    it "adds a custom user-agent" do
+      HTTParty.expects(:get).
+        with(is_a(String), has_entries(:headers => has_entries({ 'User-Agent' => "dnsimple-ruby/#{DNSimple::VERSION}" }))).
+        returns(response)
+
+      described_class.request(:get, '/foo', {})
+    end
+
+    it "performs a request" do
+      HTTParty.expects(:get).
+        with("#{described_class.base_uri}/foo",
+          :format => :json,
+          :basic_auth => { :username => described_class.username, :password => described_class.password },
+          :headers => { 'Accept' => 'application/json', 'User-Agent' => "dnsimple-ruby/#{DNSimple::VERSION}" }
+          ).
+        returns(response)
+
+      described_class.request(:get, '/foo', {})
     end
   end
 

data/spec/spec_helper.rb

@@ -22,13 +22,13 @@ RSpec.configure do |c|
   c.mock_framework = :mocha
 
   # Silent the puts call in the commands
-  c.before do
-    @_stdout = $stdout
-    $stdout = StringIO.new
-  end
-  c.after do
-    $stdout = @_stdout
-  end
+  # c.before do
+  #   @_stdout = $stdout
+  #   $stdout = StringIO.new
+  # end
+  # c.after do
+  #   $stdout = @_stdout
+  # end
 end
 
 Dir[File.join(SPEC_ROOT, "support/**/*.rb")].each { |f| require f }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dnsimple-ruby
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.5.2
 platform: ruby
 authors:
 - Anthony Eden
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-01-14 00:00:00.000000000 Z
+date: 2014-01-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httparty