zapt_in 0.0.1 → 0.0.2

data/.gitignore

@@ -3,3 +3,4 @@ pkg/*
 .bundle
 doc/*
 test.rb
+.rvmrc

data/Gemfile.lock

@@ -1,13 +1,14 @@
 PATH
   remote: .
   specs:
-    zapt_in (0.0.1)
+    zapt_in (0.0.2)
 
 GEM
   remote: http://rubygems.org/
   specs:
     ansi (1.2.5)
     fakeweb (1.3.0)
+    mocha (0.9.12)
     turn (0.8.2)
       ansi (>= 1.2.2)
 
@@ -15,6 +16,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  fakeweb
+  fakeweb (~> 1.3.0)
+  mocha
   turn (~> 0.8.2)
   zapt_in!

data/README.md

@@ -7,9 +7,9 @@ More information for API here:
 http://zapt.in/pages/api
 
 Project goals:
-* Easy to use;
-* Flexible to configure;
-* No external dependencies;
+  *Easy to use
+  *Flexible to configure
+  *No external dependencies
 
 Installation
 ------------
@@ -19,13 +19,28 @@ Installation
 Usage
 -----
 
+Case 1:
+
     require "rubygems"
     require "zapt_in"
     
-    client = ZaptIn::Client.new(:login => "login", :key => "Z_123") #=> #<ZaptIn::Client:0xb7403140 @key="Z_123", @login="login", @uri="http://zapt.in/api/links"> 
-    url = client.shorten("http://google.com") #=> #<ZaptIn::Url:0xb702daac @status_code="OK", @short_url="http://zapt.in/11jU", @error_code="0", @error_message=nil>
+    client = ZaptIn::Client.new(:login => "login", :key => "Z_123")
+    url = client.shorten("http://google.com")
     url.short_url  #=> "http://zapt.in/11jU"
   
+Case 2:
+
+    require "rubygems"
+    require "zapt_in"
+
+    #This is useful to setup config at Rails initializer for example.
+    ZaptIn.setup do |client|
+      client.uri = "http://abr.io/api/links"
+      client.login = "login"
+      client.key = "key"
+    end
+    url = ZaptIn.shorten("http://google.com")
+    url.short_url  #=> "http://abr.io/18VN"
 
 Running the Tests
 -----------------
@@ -36,7 +51,7 @@ Install development dependencies with:
 
 To run the test suite:
 
-    $ rake
+    $ rake test
 
 
 Contributing

data/lib/zapt_in/client.rb

@@ -2,7 +2,7 @@
 #Client proxy for Zapt.In or Abr.io API.
 class ZaptIn::Client
 
-  attr_reader :uri, :login, :key
+  attr_accessor :uri, :login, :key
 
   DEFAULT_PARAMS = {:format => "xml", :version => "1.0"}
 
@@ -26,8 +26,8 @@ class ZaptIn::Client
     return nil if long_url.nil? || long_url == ""
 
     @uri = options.delete(:uri) || @uri
-    params = {:login => @login || options.delete(:login),
-              :key   => @key   || options.delete(:key)}.merge(DEFAULT_PARAMS)
+    params = {:login => options.delete(:login) || @login,
+              :key   => options.delete(:key) || @key}.merge(DEFAULT_PARAMS)
     params[:longUrl] = long_url
 
     begin

data/lib/zapt_in/request.rb

@@ -10,10 +10,10 @@ class ZaptIn::Request
   #
   #Returns response body, a String.
   def self.get(uri, parameters)
-    url = URI.parse(uri)
     params = build_parameters(parameters)
 
     begin
+      url = URI.parse(uri)
       req = Net::HTTP::Get.new("#{url}?#{params}")
       res = Net::HTTP.start(url.host, url.port) do |http| 
         http.request(req)
@@ -24,7 +24,7 @@ class ZaptIn::Request
     end
   end
 
-  protected
+  private
 
   #Receives a Hash.
   #

data/lib/zapt_in/url.rb

@@ -17,16 +17,23 @@ class ZaptIn::Url
   #
   #See documentation at http://zapt.in/pages/api
   def self.parse(xml_body)
+    validates_xml(xml_body)
+
     doc = REXML::Document.new(xml_body)
 
-    attributes = {:status_code => doc.elements["zaptin/statusCode"].text,
-                  :error_message => doc.elements["zaptin/errorMessage"].text,
-                  :error_code => doc.elements["zaptin/errorCode"].text}
+    attributes = {:status_code => doc.elements["*/statusCode"].text,
+                  :error_message => doc.elements["*/errorMessage"].text,
+                  :error_code => doc.elements["*/errorCode"].text}
 
-    if (result = doc.elements["zaptin/results/nodeKeyVal"])
+    if (result = doc.elements["*/results/nodeKeyVal"])
       attributes.merge!({:short_url => result.elements["shortUrl"].text})
     end
     self.new(attributes)
   end
 
+  def self.validates_xml(xml)
+    raise ZaptIn::Error.new("XML body cannot be blank") if xml.nil? || xml.empty?
+    raise ZaptIn::Error.new("Does not appear to be a valid ZaptIn or Abrio XML.\n\n#{xml}") unless xml.start_with?("<zaptin>") || xml.start_with?("<abrio>")
+  end
+
 end

data/lib/zapt_in/version.rb

@@ -1,3 +1,3 @@
 module ZaptIn
-  VERSION = "0.0.1"
+  VERSION = "0.0.2"
 end

data/lib/zapt_in.rb

@@ -3,4 +3,29 @@ module ZaptIn
   autoload :Request, "zapt_in/request"
   autoload :Url, "zapt_in/url"
   autoload :Error, "zapt_in/error"
+
+  # Useful to set ZaptIn client parameters.
+  #
+  #     ZaptIn.setup do |client|
+  #       client.uri = "http://abr.io/api/links"
+  #       client.login = "login"
+  #       client.key = "key"
+  #     end
+  #
+  def self.setup
+    yield(client) if block_given?
+  end
+
+  # Shortcut to ZaptIn::Client.shorten
+  def self.shorten(long_url, options = {})
+    client.shorten(long_url, options)
+  end
+
+  protected
+
+  #Returns ZaptIn::Client instance
+  def self.client
+    @@client ||= Client.new
+  end
+
 end

data/test/fixtures/xml_response.rb

@@ -0,0 +1,68 @@
+module ZaptIn::Fixtures
+
+  module XmlResponse
+
+    def zaptin_success_xml
+<<XML
+<zaptin> 
+  <errorCode>0</errorCode> 
+  <errorMessage></errorMessage> 
+  <results> 
+    <nodeKeyVal> 
+      <userHash>11jU</userHash> 
+      <shortKeywordUrl></shortKeywordUrl> 
+      <hash>9</hash> 
+      <nodeKey> 
+        <![CDATA[http://google.com]]> 
+      </nodeKey> 
+      <shortUrl>http://zapt.in/11jU</shortUrl> 
+    </nodeKeyVal> 
+  </results> 
+  <statusCode>OK</statusCode> 
+</zaptin>
+XML
+    end
+
+    def zaptin_error_xml
+<<XML
+<zaptin> 
+	<errorCode>203</errorCode> 
+	<errorMessage>You must be authenticated to access shorten.</errorMessage> 
+	<statusCode>ERROR</statusCode> 
+</zaptin>
+XML
+    end
+
+    def abrio_success_xml
+<<XML
+<abrio> 
+  <errorCode>0</errorCode> 
+  <errorMessage></errorMessage> 
+  <results> 
+    <nodeKeyVal> 
+      <userHash>18VN</userHash> 
+      <shortKeywordUrl></shortKeywordUrl> 
+      <hash>3u</hash> 
+      <nodeKey> 
+        <![CDATA[http://google.com]]> 
+      </nodeKey> 
+      <shortUrl>http://abr.io/18VN</shortUrl> 
+    </nodeKeyVal> 
+  </results> 
+  <statusCode>OK</statusCode> 
+</abrio>
+XML
+    end
+
+    def abrio_error_xml
+<<XML
+<abrio> 
+	<errorCode>203</errorCode> 
+	<errorMessage>You must be authenticated to access shorten.</errorMessage> 
+	<statusCode>ERROR</statusCode> 
+</abrio>
+XML
+    end
+
+  end
+end

data/test/test_helper.rb

@@ -1,9 +1,11 @@
 require 'rubygems'
+
 require 'test/unit'
-require 'ruby-debug'
-require 'turn'
+require 'mocha'
 require 'fakeweb'
 
+require 'turn'
+
 FakeWeb.allow_net_connect = false
 
 class Test::Unit::TestCase
@@ -16,3 +18,8 @@ class Test::Unit::TestCase
 end
 
 require 'zapt_in'
+
+module ZaptIn::Fixtures
+  autoload :XmlResponse, "test/fixtures/xml_response"
+end
+

data/test/zapt_in/client_test.rb

@@ -2,8 +2,8 @@ require 'test_helper'
 
 class ZaptIn::ClientTest < Test::Unit::TestCase
 
-  def setup
-  end
+  include ZaptIn::Fixtures::XmlResponse
+  DEFAULT_EXPECTED_PARAMS = {:longUrl => 'http://google.com', :version => '1.0', :format => 'xml', :key => 'Z_VALID', :login => 'rogleite'}
 
   def test_default_configurations
     assert_equal "http://zapt.in/api/links", ZaptIn::Client.new.uri
@@ -16,23 +16,22 @@ class ZaptIn::ClientTest < Test::Unit::TestCase
   end
 
   def test_shorten_with_valid_value
-    client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_321")
+    client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_VALID")
 
-    FakeWeb.clean_registry
-    register_uri("http://zapt.in/api/links/shorten?version=1.0&login=rogleite&format=xml&key=Z_321&longUrl=http://google.com", :fixture => "shorten_success")
-    zapt_url = client.shorten("http://google.com")
+    ZaptIn::Request.expects(:get).with("#{client.uri}/shorten", DEFAULT_EXPECTED_PARAMS).returns(zaptin_success_xml)
 
+    zapt_url = client.shorten("http://google.com")
     assert_not_nil zapt_url, "expects a ZaptIn::Url"
     assert_equal "http://zapt.in/11jU", zapt_url.short_url
   end
 
   def test_shorten_options_parameter
-    client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_321")
+    client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_VALID")
 
-    FakeWeb.clean_registry
-    register_uri("http://abr.io/api/links/shorten?version=1.0&login=rogleite&format=xml&key=Z_321&longUrl=http://google.com", :fixture => "shorten_success")
+    expected_params = DEFAULT_EXPECTED_PARAMS.merge({:key => 'Z_OPTION', :login => 'login'})
+    ZaptIn::Request.expects(:get).with("http://abr.io/api/links/shorten", expected_params).returns(abrio_success_xml)
 
-    zapt_url = client.shorten("http://google.com", :uri => "http://abr.io/api/links", :login => "login", :key => "Z_123")
+    zapt_url = client.shorten("http://google.com", :uri => "http://abr.io/api/links", :login => "login", :key => "Z_OPTION")
     assert_not_nil zapt_url, "expects a ZaptIn::Url"
     assert_equal "OK", zapt_url.status_code
   end
@@ -40,8 +39,8 @@ class ZaptIn::ClientTest < Test::Unit::TestCase
   def test_shorten_failure
     client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_INVALID")
 
-    FakeWeb.clean_registry
-    register_uri("http://zapt.in/api/links/shorten?longUrl=http://google.com&version=1.0&login=rogleite&format=xml&key=Z_INVALID", :fixture => "shorten_failure")
+    expected_params = DEFAULT_EXPECTED_PARAMS.merge({:key => 'Z_INVALID'})
+    ZaptIn::Request.expects(:get).with("#{client.uri}/shorten", expected_params).returns(zaptin_error_xml)
 
     zapt_url = client.shorten("http://google.com")
     assert_not_nil zapt_url, "expects a ZaptIn::Url"
@@ -50,13 +49,12 @@ class ZaptIn::ClientTest < Test::Unit::TestCase
   end
 
   def test_shorten_net_http_error
-    FakeWeb.allow_net_connect = true
-    
+    expected_params = DEFAULT_EXPECTED_PARAMS.merge({:key => 'Z_INVALID'})
+    ZaptIn::Request.expects(:get).with("http://nonexist/shorten", expected_params).raises(ZaptIn::Error, "Net fake error")
+
     client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_INVALID")
     zapt_url = client.shorten("http://google.com", :uri => "http://nonexist")
 
-    FakeWeb.allow_net_connect = false
-
     assert_not_nil zapt_url, "expects a ZaptIn::Url"
     assert_equal "ERROR", zapt_url.status_code
     assert_nil zapt_url.short_url

data/test/zapt_in/request_test.rb

@@ -2,29 +2,23 @@ require 'test_helper'
 
 class ZaptIn::RequestTest < Test::Unit::TestCase
 
-  def test_build_parameters
-    params = {:format => "xml", :version => "1.0", :login => "login", :key => "key"}
-    assert_equal "version=1.0&login=login&format=xml&key=key", ZaptIn::Request.build_parameters(params)
-  end
-
   def test_get_request
-    register_uri(/zapt\.in\/api\/links\/shorten/, :fixture => "shorten_success")
+    register_uri("http://zapt.in/api/links/shorten?param=value", :fixture => "shorten_success")
 
     uri = "http://zapt.in/api/links/shorten"
-    params = {:format => "xml", :version => "1.0", :login => "login", :key => "key"}
+    params = {:param => "value"}
     
     response_body = ZaptIn::Request.get(uri, params)
-    assert_match /zaptin/, response_body
+    assert_match(/<zaptin>/, response_body, "Response should start with <zaptin>")
   end
 
   def test_get_invalid_request
-    FakeWeb.allow_net_connect = true
    
+    Net::HTTP.expects(:start).with("invalid.com", 80).raises(ArgumentError)
     assert_raise ZaptIn::Error do
-      ZaptIn::Request.get("http://nonexist", {})
+      ZaptIn::Request.get("http://invalid.com", {})
     end
     
-    FakeWeb.allow_net_connect = false
   end
 
 end

data/test/zapt_in/url_test.rb

@@ -0,0 +1,57 @@
+require 'test_helper'
+
+class ZaptIn::UrlTest < Test::Unit::TestCase
+
+  include ZaptIn::Fixtures::XmlResponse
+
+  def assert_success_url(url, attrs)
+    assert_not_nil url
+    assert_equal "0", url.error_code
+    assert_equal "OK", url.status_code
+    assert_equal attrs[:short_url], url.short_url
+  end
+
+  def assert_error_url(url, code, message)
+    assert_not_nil url
+    assert_equal code, url.error_code
+    assert_equal message, url.error_message
+    assert_equal "ERROR", url.status_code
+    assert_equal nil, url.short_url
+  end
+
+  def test_parse_zaptin_success_xml
+    url = ZaptIn::Url.parse(zaptin_success_xml)
+    assert_success_url url, :short_url => "http://zapt.in/11jU"
+  end
+
+  def test_parse_zaptin_error_xml
+    url = ZaptIn::Url.parse(zaptin_error_xml)
+    assert_error_url url, "203", "You must be authenticated to access shorten."
+  end
+
+  def test_parse_abrio_success_xml
+    url = ZaptIn::Url.parse(abrio_success_xml)
+    assert_success_url url, :short_url => "http://abr.io/18VN"
+  end
+
+  def test_parse_abrio_error_xml
+    url = ZaptIn::Url.parse(abrio_error_xml)
+    assert_error_url url, "203", "You must be authenticated to access shorten."
+  end
+
+  def test_parse_blank_xml
+    assert_raise ZaptIn::Error do
+      ZaptIn::Url.parse(nil)
+    end
+    assert_raise ZaptIn::Error do
+      ZaptIn::Url.parse("")
+    end
+  end
+
+  def test_parse_should_check_for_root_tags
+    assert_raise ZaptIn::Error do
+      ZaptIn::Url.parse("<h1>Some Error</h1>")
+    end
+  end
+
+end

data/test/zapt_in_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+
+class ZaptInTest < Test::Unit::TestCase
+
+  def test_setup
+    ZaptIn.setup do |client|
+      client.uri = "http://abr.io/api/links"
+      client.login = "login"
+      client.key = "key"
+    end
+
+    assert_equal "http://abr.io/api/links", ZaptIn.client.uri
+    assert_equal "login", ZaptIn.client.login
+    assert_equal "key", ZaptIn.client.key
+  end
+
+  def test_shorten
+    client = mock() do
+      expects(:shorten).with("google.com", {}).returns("OK")
+    end
+    ZaptIn.expects(:client).returns(client)
+    
+    result = ZaptIn.shorten("google.com")
+    assert_equal "OK", result
+  end
+
+end

data/zapt_in.gemspec

@@ -15,7 +15,8 @@ Gem::Specification.new do |s|
 
   #s.rubyforge_project = "zapt_in"
   s.add_development_dependency "turn", "~> 0.8.2"
-  s.add_development_dependency "fakeweb", "~> 1.0.7"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+  s.add_development_dependency "mocha", "~> 0.9.12"
 
   s.files         = `git ls-files`.split("\n")
   s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: zapt_in
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: 
   segments: 
   - 0
   - 0
-  - 1
-  version: 0.0.1
+  - 2
+  version: 0.0.2
 platform: ruby
 authors: 
 - Roger Leite
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-06 00:00:00 -03:00
+date: 2011-06-07 00:00:00 -03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -42,14 +42,30 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 25
+        hash: 27
         segments: 
         - 1
+        - 3
         - 0
-        - 7
-        version: 1.0.7
+        version: 1.3.0
   type: :development
   version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 35
+        segments: 
+        - 0
+        - 9
+        - 12
+        version: 0.9.12
+  type: :development
+  version_requirements: *id003
 description: Client ruby para os encurtadores http://zapt.in e http://abr.io
 email: 
 - roger.leite@abril.com.br
@@ -72,11 +88,13 @@ files:
 - lib/zapt_in/request.rb
 - lib/zapt_in/url.rb
 - lib/zapt_in/version.rb
-- test/fixtures/shorten_failure
 - test/fixtures/shorten_success
+- test/fixtures/xml_response.rb
 - test/test_helper.rb
 - test/zapt_in/client_test.rb
 - test/zapt_in/request_test.rb
+- test/zapt_in/url_test.rb
+- test/zapt_in_test.rb
 - zapt_in.gemspec
 has_rdoc: true
 homepage: ""

data/test/fixtures/shorten_failure

@@ -1,18 +0,0 @@
-HTTP/1.1 200 OK
-Server: nginx/0.7.67
-Date: Mon, 06 Jun 2011 17:42:58 GMT
-Content-Type: application/xml; charset=utf-8
-Connection: keep-alive
-X-Runtime: 12
-Etag: "9cd7a5d7537c402e82dfc1612e7d2dea"
-Cache-Control: private, max-age=0, must-revalidate
-Content-Length: 153
-X-Varnish: 247868969
-Age: 0
-Via: 1.1 varnish
-
-<zaptin>
-	<errorCode>203</errorCode>
-	<errorMessage>You must be authenticated to access shorten.</errorMessage>
-	<statusCode>ERROR</statusCode>
-</zaptin>