pixy 0.0.2 → 0.1.0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 .rvmrc
+ruby/

data/README.md

@@ -14,19 +14,22 @@ gem 'pixy'
 ## Usage
 
 ```ruby
-url = Pixy.shorten!(API_KEY, 'https://github.com/narkoz/pixy')
+Pixy.shorten!(API_KEY, 'https://github.com/narkoz/pixy')
+# => "http://p.tl/Us9R"
+
+pixy = Pixy.shorten(API_KEY, 'https://github.com/narkoz/pixy')
 # => #<Pixy::Shorten:0x0000010201bde8 @status="ok", @long_url="https://github.com/narkoz/pixy", @short_url="http://p.tl/Us9R", @counter=20>
 
-url.status
+pixy.status
 # => "ok"
 
-url.long_url
+pixy.long_url
 # => "https://github.com/narkoz/pixy"
 
-url.short_url
+pixy.short_url
 # => "http://p.tl/Us9R"
 
-url.counter
+pixy.counter
 # => 20
 ```
 

data/lib/pixy.rb

@@ -1,14 +1,18 @@
 require 'pixy/version'
 require 'pixy/shorten'
+require 'pixy/errors'
 require 'net/http'
 require 'json'
 
 module Pixy
   extend self
 
-  def shorten!(key=nil, url='')
-    raise ArgumentError, "API key is required" if key.nil?
+  def shorten(key=nil, url='')
+    raise MissingApiKey, "API key is required" if key.nil?
     Pixy::Shorten.new(key, url)
   end
-  alias_method :shorten, :shorten!
+
+  def shorten!(key=nil, url='')
+    Pixy.shorten(key, url).short_url
+  end
 end

data/lib/pixy/errors.rb

@@ -0,0 +1,9 @@
+module Pixy
+  class EmptyLongUrl < StandardError; end
+  class EmptyApiKey < StandardError; end
+  class ApiLimit < StandardError; end
+  class InvalidApiKey < StandardError; end
+  class InvalidLongUrl < StandardError; end
+  class UnknownError < StandardError; end
+  class MissingApiKey < ArgumentError; end
+end

data/lib/pixy/shorten.rb

@@ -1,10 +1,10 @@
 module Pixy
   class Shorten
+    API_URL = 'http://p.tl/api/api_simple.php'
     attr_accessor :status, :long_url, :short_url, :counter
 
     def initialize(key, url)
-      uri       = URI('http://p.tl/api/api_simple.php')
-      uri.query = URI.encode_www_form({:key => key, :url => url})
+      uri       = URI "#{API_URL}?key=#{key}&url=#{escape_url(url)}"
       response  = Net::HTTP.get_response(uri)
       result    = JSON.parse(response.body)
 
@@ -13,9 +13,33 @@ module Pixy
         self.long_url   = result['long_url']
         self.short_url  = result['short_url']
         self.counter    = result['counter']
+        raise_exception self.status unless self.status == 'ok'
       else
-        raise "Server responded with code #{response.code}"
+        raise UnknownError, "Server responded with code #{response.code}"
       end
     end
+
+    private
+
+    def raise_exception(status)
+      case status
+      when 'empty long url'
+        raise EmptyLongUrl, "Missing long URL."
+      when 'empty API key'
+        raise EmptyApiKey, "Missing API key."
+      when 'API limit'
+        raise ApiLimit, "API limit exceeded."
+      when 'invalid API key'
+        raise InvalidApiKey, "API key is invalid."
+      when 'invalid long url'
+        raise InvalidLongUrl, "The URL can not be shortened."
+      else
+        raise UnknownError, "Unknown status error."
+      end
+    end
+
+    def escape_url(url)
+      URI.escape(url, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+    end
   end
 end

data/lib/pixy/version.rb

@@ -1,3 +1,3 @@
 module Pixy
-  VERSION = "0.0.2"
+  VERSION = "0.1.0"
 end

data/spec/fixtures/empty_api_key.json

@@ -0,0 +1,6 @@
+{
+  "status": "empty API key",
+  "long_url": "https://github.com/narkoz/pixy",
+  "short_url": "",
+  "counter": 0
+}

data/spec/fixtures/empty_long_url.json

@@ -0,0 +1,6 @@
+{
+  "status": "empty long url",
+  "long_url": "",
+  "short_url": "",
+  "counter": 0
+}

data/spec/fixtures/invalid_api_key.json

@@ -0,0 +1,6 @@
+{
+  "status": "invalid API key",
+  "long_url": "https://github.com/narkoz/pixy",
+  "short_url": "",
+  "counter": 0
+}

data/spec/fixtures/invalid_long_url.json

@@ -0,0 +1,6 @@
+{
+  "status": "invalid long url",
+  "long_url": "^_^",
+  "short_url": "",
+  "counter": 20
+}

data/spec/fixtures/ok.json

@@ -0,0 +1,6 @@
+{
+  "status": "ok",
+  "long_url": "https://github.com/narkoz/pixy",
+  "short_url": "http://p.tl/Us9R",
+  "counter": 12
+}

data/spec/pixy/shorten_spec.rb

@@ -1,18 +1,24 @@
 require 'spec_helper'
 
 describe Pixy::Shorten do
-  context "when a new short url requested" do
-    it { Pixy.should respond_to(:shorten!) }
-    it { Pixy.should respond_to(:shorten) }
+  it { Pixy.should respond_to :shorten }
+  it { Pixy.should respond_to :shorten! }
 
+  describe "#shorten!" do
+    it "should return a short url" do
+      Pixy.shorten!('API_KEY', 'https://github.com/narkoz/pixy').should == 'http://p.tl/Us9R'
+    end
+  end
+
+  context "when a new short url requested" do
     context "without arguments" do
       it "should raise a required API key error" do
-        lambda { Pixy.shorten! }.should raise_error(ArgumentError, "API key is required")
+        lambda { Pixy.shorten }.should raise_error(Pixy::MissingApiKey, "API key is required")
       end
     end
 
     context "with arguments" do
-      subject { Pixy.shorten!('API_KEY', 'https://github.com/narkoz/pixy') }
+      subject { Pixy.shorten('API_KEY', 'https://github.com/narkoz/pixy') }
 
       describe "#status" do
         it "should return a response status" do
@@ -37,6 +43,38 @@ describe Pixy::Shorten do
           subject.counter.should == 12
         end
       end
+
+      context "with empty long url" do
+        it "should raise EmptyLongUrl" do
+          lambda {
+            Pixy.shorten('API_KEY', '')
+          }.should raise_error(Pixy::EmptyLongUrl, "Missing long URL.")
+        end
+      end
+
+      context "with empty API key" do
+        it "should raise EmptyApiKey" do
+          lambda {
+            Pixy.shorten('', 'https://github.com/narkoz/pixy')
+          }.should raise_error(Pixy::EmptyApiKey, "Missing API key.")
+        end
+      end
+
+      context "with invalid API key" do
+        it "should raise InvalidApiKey" do
+          lambda {
+            Pixy.shorten('invalid_API_KEY', 'https://github.com/narkoz/pixy')
+          }.should raise_error(Pixy::InvalidApiKey, "API key is invalid.")
+        end
+      end
+
+      context "with invalid long url" do
+        it "should raise InvalidLongUrl" do
+          lambda {
+            Pixy.shorten('API_KEY', '^_^')
+          }.should raise_error(Pixy::InvalidLongUrl, "The URL can not be shortened.")
+        end
+      end
     end
   end
 end

data/spec/spec_helper.rb

@@ -4,12 +4,24 @@ require 'pixy'
 
 FakeWeb.allow_net_connect = false
 
-url_to_shorten = "https%3A%2F%2Fgithub.com%2Fnarkoz%2Fpixy"
-FakeWeb.register_uri(:get,
-        "http://p.tl/api/api_simple.php?key=API_KEY&url=#{url_to_shorten}",
-        :body => {
-          :status     => 'ok',
-          :long_url   => 'https://github.com/narkoz/pixy',
-          :short_url  => 'http://p.tl/Us9R',
-          :counter    => 12
-        }.to_json)
+def escape_url(url)
+  URI.escape(url, Regexp.new("[^#{URI::PATTERN::UNRESERVED}]"))
+end
+
+API_URL                 = 'http://p.tl/api/api_simple.php'
+url_to_shorten          = escape_url("https://github.com/narkoz/pixy")
+invalid_url_to_shorten  = escape_url("^_^")
+
+def load_fixture(name)
+  File.open(File.dirname(__FILE__) + "/fixtures/#{name}.json").read
+end
+
+def fake_url(url, fixture_name)
+  FakeWeb.register_uri(:get, url, :body => load_fixture(fixture_name))
+end
+
+fake_url "#{API_URL}?key=API_KEY&url=#{url_to_shorten}", 'ok'
+fake_url "#{API_URL}?key=API_KEY&url=", 'empty_long_url'
+fake_url "#{API_URL}?key=&url=#{url_to_shorten}", 'empty_api_key'
+fake_url "#{API_URL}?key=invalid_API_KEY&url=#{url_to_shorten}", 'invalid_api_key'
+fake_url "#{API_URL}?key=API_KEY&url=#{invalid_url_to_shorten}", 'invalid_long_url'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pixy
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.1.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-12-15 00:00:00.000000000 Z
+date: 2011-12-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &2151939620 !ruby/object:Gem::Requirement
+  requirement: &2164331840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *2151939620
+  version_requirements: *2164331840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &2151939040 !ruby/object:Gem::Requirement
+  requirement: &2164331040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151939040
+  version_requirements: *2164331040
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &2151937580 !ruby/object:Gem::Requirement
+  requirement: &2164330600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151937580
+  version_requirements: *2164330600
 - !ruby/object:Gem::Dependency
   name: fakeweb
-  requirement: &2151937040 !ruby/object:Gem::Requirement
+  requirement: &2164329980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,7 +54,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *2151937040
+  version_requirements: *2164329980
 description: Pixy is an API wrapper for Pixiv url shortener - p.tl
 email:
 - mail@narkoz.me
@@ -69,9 +69,15 @@ files:
 - README.md
 - Rakefile
 - lib/pixy.rb
+- lib/pixy/errors.rb
 - lib/pixy/shorten.rb
 - lib/pixy/version.rb
 - pixy.gemspec
+- spec/fixtures/empty_api_key.json
+- spec/fixtures/empty_long_url.json
+- spec/fixtures/invalid_api_key.json
+- spec/fixtures/invalid_long_url.json
+- spec/fixtures/ok.json
 - spec/pixy/shorten_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/narkoz/pixy
@@ -99,5 +105,10 @@ signing_key:
 specification_version: 3
 summary: API wrapper for Pixiv url shortener
 test_files:
+- spec/fixtures/empty_api_key.json
+- spec/fixtures/empty_long_url.json
+- spec/fixtures/invalid_api_key.json
+- spec/fixtures/invalid_long_url.json
+- spec/fixtures/ok.json
 - spec/pixy/shorten_spec.rb
 - spec/spec_helper.rb