zapt_in 0.0.1

data/.gitignore

@@ -0,0 +1,5 @@
+pkg/*
+*.gem
+.bundle
+doc/*
+test.rb

data/Gemfile

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

data/Gemfile.lock

@@ -0,0 +1,20 @@
+PATH
+  remote: .
+  specs:
+    zapt_in (0.0.1)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    ansi (1.2.5)
+    fakeweb (1.3.0)
+    turn (0.8.2)
+      ansi (>= 1.2.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  fakeweb
+  turn (~> 0.8.2)
+  zapt_in!

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Roger Leite
+
+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,55 @@
+ZaptIn
+======
+
+A Ruby API for http://zapt.in and http://abr.io
+
+More information for API here:
+http://zapt.in/pages/api
+
+Project goals:
+* Easy to use;
+* Flexible to configure;
+* No external dependencies;
+
+Installation
+------------
+
+    gem install zapt_in
+
+Usage
+-----
+
+    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>
+    url.short_url  #=> "http://zapt.in/11jU"
+  
+
+Running the Tests
+-----------------
+
+Install development dependencies with:
+
+    $ bundle install
+
+To run the test suite:
+
+    $ rake
+
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork][0] zapt_in
+2. Create a topic branch - `git checkout -b my_branch`
+3. Push to your branch - `git push origin my_branch`
+4. Create an [Issue][1] with a link to your branch
+5. That's it!
+
+
+[0]: http://help.github.com/forking/
+[1]: https://github.com/rogerleite/zapt_in/issues

data/Rakefile

@@ -0,0 +1,27 @@
+require 'rake'
+require 'rake/testtask'
+require 'rake/rdoctask'
+require 'bundler'
+
+Bundler::GemHelper.install_tasks
+ 
+desc 'Generate API documentation to doc/rdocs/index.html'
+Rake::RDocTask.new do |rd|
+  rd.rdoc_dir = 'doc'
+  rd.main = 'README.md'
+  rd.rdoc_files.include "README.md", "LICENSE", "lib/**/*\.rb"
+ 
+  rd.options << '--inline-source'
+  rd.options << '--line-numbers'
+  rd.options << '--all'
+  rd.options << '--fileboxes'
+end
+
+desc "Run tests"
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/**/*.rb']
+  t.verbose = true
+end
+
+task :default => :test

data/lib/zapt_in/client.rb

@@ -0,0 +1,41 @@
+
+#Client proxy for Zapt.In or Abr.io API.
+class ZaptIn::Client
+
+  attr_reader :uri, :login, :key
+
+  DEFAULT_PARAMS = {:format => "xml", :version => "1.0"}
+
+  #Use the following options to initialize your client:
+  #  [uri] - Default: "zapt.in/api/links"
+  #  [login] - Your login from Zapt.In. See: http://zapt.in/pages/api
+  #  [key] - Your key from Zapt.In. See: http://zapt.in/pages/api
+  def initialize(options = {})
+    @uri = options[:uri] || "http://zapt.in/api/links"
+    @login = options[:login]
+    @key = options[:key]
+  end
+
+  #Shorten an url.
+  #[long_url] url you want to shorten.
+  #[options] Optional Hash. You can pass the following keys:
+  #  [uri] - Default: "zapt.in/api/links"
+  #  [login] - Your login from Zapt.In. See: http://zapt.in/pages/api
+  #  [key] - Your key from Zapt.In. See: http://zapt.in/pages/api
+  def shorten(long_url, options = {})
+    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[:longUrl] = long_url
+
+    begin
+      response = ZaptIn::Request.get("#{self.uri}/shorten", params)
+      ZaptIn::Url.parse(response)
+    rescue ZaptIn::Error => e
+      ZaptIn::Url.new(:status_code => "ERROR", :errorMessage => e.message, :error_code => -1)
+    end
+  end
+
+end

data/lib/zapt_in/error.rb

@@ -0,0 +1,3 @@
+
+class ZaptIn::Error < StandardError
+end

data/lib/zapt_in/request.rb

@@ -0,0 +1,38 @@
+require "net/http"
+require "uri"
+
+#Wrapper responsible for all requests.
+class ZaptIn::Request
+  
+  #Call get at *uri* with *parameters*.
+  #[uri] Complete url. Example: http://zapt.in/api/links/shorten
+  #[parameters] Hash of parameters. Example: {:format => "xml", :version => "1.0"}
+  #
+  #Returns response body, a String.
+  def self.get(uri, parameters)
+    url = URI.parse(uri)
+    params = build_parameters(parameters)
+
+    begin
+      req = Net::HTTP::Get.new("#{url}?#{params}")
+      res = Net::HTTP.start(url.host, url.port) do |http| 
+        http.request(req)
+      end
+      res.body
+    rescue StandardError => e
+      raise ZaptIn::Error.new(e)
+    end
+  end
+
+  protected
+
+  #Receives a Hash.
+  #
+  #Returns a String in format: "key=value&key2=value2"
+  def self.build_parameters(params)
+    array_params = []
+    params.each_pair { |key, value| array_params << "#{key}=#{value}"}
+    array_params.join("&")
+  end
+
+end

data/lib/zapt_in/url.rb

@@ -0,0 +1,32 @@
+require 'rexml/document'
+
+#Represents ZaptIn API response.
+class ZaptIn::Url
+
+  attr_reader :status_code, :error_message, :error_code
+  attr_reader :short_url
+
+  #Initialize all read-only atributes with Hash.
+  def initialize(attrs = {})
+    attrs.each_pair do |attr, value|
+      self.instance_variable_set("@#{attr}", value)
+    end
+  end
+
+  #Parses *xml* from ZaptIn API.
+  #
+  #See documentation at http://zapt.in/pages/api
+  def self.parse(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}
+
+    if (result = doc.elements["zaptin/results/nodeKeyVal"])
+      attributes.merge!({:short_url => result.elements["shortUrl"].text})
+    end
+    self.new(attributes)
+  end
+
+end

data/lib/zapt_in/version.rb

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

data/lib/zapt_in.rb

@@ -0,0 +1,6 @@
+module ZaptIn
+  autoload :Client, "zapt_in/client"
+  autoload :Request, "zapt_in/request"
+  autoload :Url, "zapt_in/url"
+  autoload :Error, "zapt_in/error"
+end

data/test/fixtures/shorten_failure

@@ -0,0 +1,18 @@
+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>

data/test/fixtures/shorten_success

@@ -0,0 +1,29 @@
+HTTP/1.1 200 OK
+Server: nginx/0.7.67
+Date: Fri, 03 Jun 2011 18:17:52 GMT
+Content-Type: application/xml; charset=utf-8
+Connection: keep-alive
+X-Runtime: 33
+ETag: "96e2aec9b5358bed89d8345f4d94b969"
+Cache-Control: private, max-age=0, must-revalidate
+Content-Length: 380
+X-Varnish: 981428441
+Age: 0
+Via: 1.1 varnish
+
+<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>

data/test/test_helper.rb

@@ -0,0 +1,18 @@
+require 'rubygems'
+require 'test/unit'
+require 'ruby-debug'
+require 'turn'
+require 'fakeweb'
+
+FakeWeb.allow_net_connect = false
+
+class Test::Unit::TestCase
+
+  def register_uri(url, options = {})
+    fixture = options.delete(:fixture)
+    FakeWeb.register_uri(:get, url, :response => File.read("test/fixtures/#{fixture}"))
+  end
+
+end
+
+require 'zapt_in'

data/test/zapt_in/client_test.rb

@@ -0,0 +1,65 @@
+require 'test_helper'
+
+class ZaptIn::ClientTest < Test::Unit::TestCase
+
+  def setup
+  end
+
+  def test_default_configurations
+    assert_equal "http://zapt.in/api/links", ZaptIn::Client.new.uri
+  end
+
+  def test_shorten_with_blank_value
+    client = ZaptIn::Client.new
+    assert_equal nil, client.shorten(nil)
+    assert_equal nil, client.shorten("")
+  end
+
+  def test_shorten_with_valid_value
+    client = ZaptIn::Client.new(:login => "rogleite", :key => "Z_321")
+
+    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")
+
+    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")
+
+    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")
+
+    zapt_url = client.shorten("http://google.com", :uri => "http://abr.io/api/links", :login => "login", :key => "Z_123")
+    assert_not_nil zapt_url, "expects a ZaptIn::Url"
+    assert_equal "OK", zapt_url.status_code
+  end
+
+  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")
+
+    zapt_url = client.shorten("http://google.com")
+    assert_not_nil zapt_url, "expects a ZaptIn::Url"
+    assert_equal "ERROR", zapt_url.status_code
+    assert_nil zapt_url.short_url
+  end
+
+  def test_shorten_net_http_error
+    FakeWeb.allow_net_connect = true
+    
+    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
+  end
+
+end

data/test/zapt_in/request_test.rb

@@ -0,0 +1,30 @@
+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")
+
+    uri = "http://zapt.in/api/links/shorten"
+    params = {:format => "xml", :version => "1.0", :login => "login", :key => "key"}
+    
+    response_body = ZaptIn::Request.get(uri, params)
+    assert_match /zaptin/, response_body
+  end
+
+  def test_get_invalid_request
+    FakeWeb.allow_net_connect = true
+   
+    assert_raise ZaptIn::Error do
+      ZaptIn::Request.get("http://nonexist", {})
+    end
+    
+    FakeWeb.allow_net_connect = false
+  end
+
+end

data/zapt_in.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "zapt_in/version"
+
+Gem::Specification.new do |s|
+  s.name        = "zapt_in"
+  s.version     = ZaptIn::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Roger Leite"]
+  s.email       = ["roger.leite@abril.com.br"]
+  s.homepage    = ""
+  s.summary     = %q{Client ruby para os encurtadores http://zapt.in e http://abr.io}
+  s.description = %q{Client ruby para os encurtadores http://zapt.in e http://abr.io}
+  s.required_ruby_version = ">= 1.8.7"
+
+  #s.rubyforge_project = "zapt_in"
+  s.add_development_dependency "turn", "~> 0.8.2"
+  s.add_development_dependency "fakeweb", "~> 1.0.7"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

metadata

@@ -0,0 +1,118 @@
+--- !ruby/object:Gem::Specification 
+name: zapt_in
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Roger Leite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-06 00:00:00 -03:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: turn
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 59
+        segments: 
+        - 0
+        - 8
+        - 2
+        version: 0.8.2
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 25
+        segments: 
+        - 1
+        - 0
+        - 7
+        version: 1.0.7
+  type: :development
+  version_requirements: *id002
+description: Client ruby para os encurtadores http://zapt.in e http://abr.io
+email: 
+- roger.leite@abril.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/zapt_in.rb
+- lib/zapt_in/client.rb
+- lib/zapt_in/error.rb
+- lib/zapt_in/request.rb
+- lib/zapt_in/url.rb
+- lib/zapt_in/version.rb
+- test/fixtures/shorten_failure
+- test/fixtures/shorten_success
+- test/test_helper.rb
+- test/zapt_in/client_test.rb
+- test/zapt_in/request_test.rb
+- zapt_in.gemspec
+has_rdoc: true
+homepage: ""
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 57
+      segments: 
+      - 1
+      - 8
+      - 7
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.4.1
+signing_key: 
+specification_version: 3
+summary: Client ruby para os encurtadores http://zapt.in e http://abr.io
+test_files: []
+