abrio 0.0.5

data/.gitignore

@@ -0,0 +1,7 @@
+pkg/*
+*.gem
+.bundle
+doc/*
+test.rb
+.rvmrc
+tags

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:
+    abrio (0.0.5)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    fakeweb (1.3.0)
+    metaclass (0.0.1)
+    mocha (0.10.4)
+      metaclass (~> 0.0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  abrio!
+  fakeweb (~> 1.3.0)
+  mocha (~> 0.10.0)

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,70 @@
+Abrio
+======
+
+A Ruby API for http://abr.io
+
+More information for API here:
+http://abr.io/pages/api
+
+Project goals:
+  *Easy to use
+  *Flexible to configure
+  *No external dependencies
+
+Installation
+------------
+
+    gem install abrio
+
+Usage
+-----
+
+Case 1:
+
+    require "rubygems"
+    require "abrio"
+
+    client = Abrio::Client.new(:login => "login", :key => "Z_123")
+    url = client.shorten("http://google.com")
+    url.short_url  #=> "http://abr.io/11jU"
+
+Case 2:
+
+    require "rubygems"
+    require "abrio"
+
+    #This is useful to setup config at Rails initializer for example.
+    Abrio.setup do |client|
+      client.uri = "http://abr.io/api/links"
+      client.login = "login"
+      client.key = "key"
+    end
+    url = Abrio.shorten("http://google.com")
+    url.short_url  #=> "http://abr.io/18VN"
+
+Running the Tests
+-----------------
+
+Install development dependencies with:
+
+    $ bundle install
+
+To run the test suite:
+
+    $ rake test
+
+
+Contributing
+------------
+
+Once you've made your great commits:
+
+1. [Fork][0] abrio
+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/abril/abrio/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/abrio.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "abrio/version"
+
+Gem::Specification.new do |s|
+  s.name        = "abrio"
+  s.version     = Abrio::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 o encurtador http://abr.io}
+  s.description = %q{Client ruby para o encurtador http://abr.io}
+  s.required_ruby_version = ">= 1.8.7"
+
+  #s.rubyforge_project = "abrio"
+  s.add_development_dependency "fakeweb", "~> 1.3.0"
+  s.add_development_dependency "mocha", "~> 0.10.0"
+
+  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

data/lib/abrio.rb

@@ -0,0 +1,31 @@
+module Abrio
+  autoload :Client, "abrio/client"
+  autoload :Request, "abrio/request"
+  autoload :Url, "abrio/url"
+  autoload :Error, "abrio/error"
+
+  # Useful to set Abrio client parameters.
+  #
+  #     Abrio.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 Abrio::Client.shorten
+  def self.shorten(long_url, options = {})
+    client.shorten(long_url, options)
+  end
+
+  protected
+
+  #Returns Abrio::Client instance
+  def self.client
+    @@client ||= Client.new
+  end
+
+end

data/lib/abrio/client.rb

@@ -0,0 +1,40 @@
+#Client proxy for Abr.io API.
+class Abrio::Client
+
+  attr_accessor :uri, :login, :key
+
+  DEFAULT_PARAMS = {:format => "xml", :version => "1.0"}
+
+  #Use the following options to initialize your client:
+  #  [uri] - Default: "abr.io/api/links"
+  #  [login] - Your login from Zapt.In. See: http://abr.io/pages/api
+  #  [key] - Your key from Zapt.In. See: http://abr.io/pages/api
+  def initialize(options = {})
+    @uri = options[:uri] || "http://abr.io/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: "abr.io/api/links"
+  #  [login] - Your login from Zapt.In. See: http://abr.io/pages/api
+  #  [key] - Your key from Zapt.In. See: http://abr.io/pages/api
+  def shorten(long_url, options = {})
+    return nil if long_url.nil? || long_url == ""
+
+    @uri = options.delete(:uri) || @uri
+    params = {:login => options.delete(:login) || @login,
+              :key   => options.delete(:key) || @key}.merge(DEFAULT_PARAMS)
+    params[:longUrl] = long_url
+
+    begin
+      response = Abrio::Request.get("#{self.uri}/shorten", params)
+      Abrio::Url.parse(response)
+    rescue Abrio::Error => e
+      Abrio::Url.new(:status_code => "ERROR", :errorMessage => e.message, :error_code => -1)
+    end
+  end
+
+end

data/lib/abrio/error.rb

@@ -0,0 +1,2 @@
+class Abrio::Error < StandardError
+end

data/lib/abrio/request.rb

@@ -0,0 +1,38 @@
+require "net/http"
+require "uri"
+
+#Wrapper responsible for all requests.
+class Abrio::Request
+
+  #Call get at *uri* with *parameters*.
+  #[uri] Complete url. Example: http://abr.io/api/links/shorten
+  #[parameters] Hash of parameters. Example: {:format => "xml", :version => "1.0"}
+  #
+  #Returns response body, a String.
+  def self.get(uri, parameters)
+    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)
+      end
+      res.body
+    rescue StandardError => e
+      raise Abrio::Error.new(e)
+    end
+  end
+
+  private
+
+  #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/abrio/url.rb

@@ -0,0 +1,39 @@
+require 'rexml/document'
+
+#Represents Abrio API response.
+class Abrio::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 Abrio API.
+  #
+  #See documentation at http://abr.io/pages/api
+  def self.parse(xml_body)
+    validates_xml(xml_body)
+
+    doc = REXML::Document.new(xml_body)
+
+    attributes = {:status_code => doc.elements["*/statusCode"].text,
+                  :error_message => doc.elements["*/errorMessage"].text,
+                  :error_code => doc.elements["*/errorCode"].text}
+
+    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 Abrio::Error.new("XML body cannot be blank") if xml.nil? || xml.empty?
+    raise Abrio::Error.new("Does not appear to be a valid Abrio XML.\n\n#{xml}") unless xml.start_with?("<abrio>")
+  end
+
+end

data/lib/abrio/version.rb

@@ -0,0 +1,3 @@
+module Abrio
+  VERSION = "0.0.5"
+end

data/test/abrio/client_test.rb

@@ -0,0 +1,63 @@
+require 'test_helper'
+
+class Abrio::ClientTest < Test::Unit::TestCase
+
+  include Abrio::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://abr.io/api/links", Abrio::Client.new.uri
+  end
+
+  def test_shorten_with_blank_value
+    client = Abrio::Client.new
+    assert_equal nil, client.shorten(nil)
+    assert_equal nil, client.shorten("")
+  end
+
+  def test_shorten_with_valid_value
+    client = Abrio::Client.new(:login => "rogleite", :key => "Z_VALID")
+
+    Abrio::Request.expects(:get).with("#{client.uri}/shorten", DEFAULT_EXPECTED_PARAMS).returns(abrio_success_xml)
+
+    abrio_url = client.shorten("http://google.com")
+    assert_not_nil abrio_url, "expects a Abrio::Url"
+    assert_equal "http://abr.io/18VN", abrio_url.short_url
+  end
+
+  def test_shorten_options_parameter
+    client = Abrio::Client.new(:login => "rogleite", :key => "Z_VALID")
+
+    expected_params = DEFAULT_EXPECTED_PARAMS.merge({:key => 'Z_OPTION', :login => 'login'})
+    Abrio::Request.expects(:get).with("http://abr.io/api/links/shorten", expected_params).returns(abrio_success_xml)
+
+    abrio_url = client.shorten("http://google.com", :uri => "http://abr.io/api/links", :login => "login", :key => "Z_OPTION")
+    assert_not_nil abrio_url, "expects a Abrio::Url"
+    assert_equal "OK", abrio_url.status_code
+  end
+
+  def test_shorten_failure
+    client = Abrio::Client.new(:login => "rogleite", :key => "Z_INVALID")
+
+    expected_params = DEFAULT_EXPECTED_PARAMS.merge({:key => 'Z_INVALID'})
+    Abrio::Request.expects(:get).with("#{client.uri}/shorten", expected_params).returns(abrio_error_xml)
+
+    abrio_url = client.shorten("http://google.com")
+    assert_not_nil abrio_url, "expects a Abrio::Url"
+    assert_equal "ERROR", abrio_url.status_code
+    assert_nil abrio_url.short_url
+  end
+
+  def test_shorten_net_http_error
+    expected_params = DEFAULT_EXPECTED_PARAMS.merge({:key => 'Z_INVALID'})
+    Abrio::Request.expects(:get).with("http://nonexist/shorten", expected_params).raises(Abrio::Error, "Net fake error")
+
+    client = Abrio::Client.new(:login => "rogleite", :key => "Z_INVALID")
+    abrio_url = client.shorten("http://google.com", :uri => "http://nonexist")
+
+    assert_not_nil abrio_url, "expects a Abrio::Url"
+    assert_equal "ERROR", abrio_url.status_code
+    assert_nil abrio_url.short_url
+  end
+
+end

data/test/abrio/request_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class Abrio::RequestTest < Test::Unit::TestCase
+
+  def test_get_request
+    register_uri("http://abr.io/api/links/shorten?param=value", :fixture => "shorten_success")
+
+    uri = "http://abr.io/api/links/shorten"
+    params = {:param => "value"}
+
+    response_body = Abrio::Request.get(uri, params)
+    assert_match(/<abrio>/, response_body, "Response should start with <abrio>")
+  end
+
+  def test_get_invalid_request
+
+    Net::HTTP.expects(:start).with("invalid.com", 80).raises(ArgumentError)
+    assert_raise Abrio::Error do
+      Abrio::Request.get("http://invalid.com", {})
+    end
+
+  end
+
+end

data/test/abrio/url_test.rb

@@ -0,0 +1,47 @@
+require 'test_helper'
+
+class Abrio::UrlTest < Test::Unit::TestCase
+
+  include Abrio::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_abrio_success_xml
+    url = Abrio::Url.parse(abrio_success_xml)
+    assert_success_url url, :short_url => "http://abr.io/18VN"
+  end
+
+  def test_parse_abrio_error_xml
+    url = Abrio::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 Abrio::Error do
+      Abrio::Url.parse(nil)
+    end
+    assert_raise Abrio::Error do
+      Abrio::Url.parse("")
+    end
+  end
+
+  def test_parse_should_check_for_root_tags
+    assert_raise Abrio::Error do
+      Abrio::Url.parse("<h1>Some Error</h1>")
+    end
+  end
+
+end

data/test/abrio_test.rb

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

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
+
+<abrio>
+  <errorCode>0</errorCode>
+  <errorMessage></errorMessage>
+  <results>
+    <nodeKeyVal>
+      <userHash>11jU</userHash>
+      <shortKeywordUrl></shortKeywordUrl>
+      <hash>9</hash>
+      <nodeKey>
+        <![CDATA[http://google.com]]>
+      </nodeKey>
+      <shortUrl>http://abr.io/11jU</shortUrl>
+    </nodeKeyVal>
+  </results>
+  <statusCode>OK</statusCode>
+</abrio>

data/test/fixtures/xml_response.rb

@@ -0,0 +1,41 @@
+module Abrio
+
+module Fixtures
+
+  module XmlResponse
+
+    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
+
+end

data/test/test_helper.rb

@@ -0,0 +1,23 @@
+require 'rubygems'
+
+require 'test/unit'
+require 'mocha'
+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 'abrio'
+
+module Abrio::Fixtures
+  autoload :XmlResponse, "test/fixtures/xml_response"
+end
+

metadata

@@ -0,0 +1,124 @@
+--- !ruby/object:Gem::Specification 
+name: abrio
+version: !ruby/object:Gem::Version 
+  hash: 21
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 5
+  version: 0.0.5
+platform: ruby
+authors: 
+- Roger Leite
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-02-17 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 27
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 55
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :development
+  version_requirements: *id002
+description: Client ruby para o encurtador http://abr.io
+email: 
+- roger.leite@abril.com.br
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- abrio.gemspec
+- lib/abrio.rb
+- lib/abrio/client.rb
+- lib/abrio/error.rb
+- lib/abrio/request.rb
+- lib/abrio/url.rb
+- lib/abrio/version.rb
+- test/abrio/client_test.rb
+- test/abrio/request_test.rb
+- test/abrio/url_test.rb
+- test/abrio_test.rb
+- test/fixtures/shorten_success
+- test/fixtures/xml_response.rb
+- test/test_helper.rb
+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.8.15
+signing_key: 
+specification_version: 3
+summary: Client ruby para o encurtador http://abr.io
+test_files: 
+- test/abrio/client_test.rb
+- test/abrio/request_test.rb
+- test/abrio/url_test.rb
+- test/abrio_test.rb
+- test/fixtures/shorten_success
+- test/fixtures/xml_response.rb
+- test/test_helper.rb