link_shrink 0.0.5 → 0.0.6

data/.travis.yml

@@ -14,4 +14,5 @@ notifications:
     - irc.freenode.org#rubyonadhd
 env:
   global:
-    secure: bPqqN6twAJeRIpUEGozFIV3+dW2TSRxYQRrQhpzJ6Bx2ZXmk8UWl1O57Scf9/ZrCjo23MSvWKY1Rt1eyncaUVfzr4PjR6GjUwwdE7SPHQFKvGeNLIlJElzcz1ywcX6RU8+6JPYnx3NxR2O5VM8rf7wLwma00nuaDunM5NgKMMdQ=
+  - secure: bPqqN6twAJeRIpUEGozFIV3+dW2TSRxYQRrQhpzJ6Bx2ZXmk8UWl1O57Scf9/ZrCjo23MSvWKY1Rt1eyncaUVfzr4PjR6GjUwwdE7SPHQFKvGeNLIlJElzcz1ywcX6RU8+6JPYnx3NxR2O5VM8rf7wLwma00nuaDunM5NgKMMdQ=
+  - secure: JfAnh3FV1Q5Sz+QydZ7hFCCvCTiJoYqM4h0ztzZU/fqDNKo6d1/h8RWGZL++d7Ofl3Z7Jrfbj/1R4f8UiwNJVdqRMPgSrbbif8LfVBmsTtZm/gFcL5WFhm/kzIi7Jp7FmzNQc6Hx+EiI3T2mtLw51fi7lNNonVhevyEetUSvG2Q=

data/Changelog.md

@@ -1,5 +1,16 @@
 # LinkShrink Changelog
 
+## 0.0.6
+
+Released September 8, 2013 ([0.0.6](https://github.com/jonahoffline/link_shrink/tree/v0.0.6)).
+
+* Add Owly Shrinker
+* Add option for selecting Owly Shrinker in command-line application.
+* Add new mini DSL to ::Shrinkers::Base for defining the response structure to be parsed.
+* Update Google class to use the response_options configuration.
+* Update README with a new options and configuration.
+* Update version to 0.0.6
+
 ## 0.0.5
 
 Released September 7, 2013 ([0.0.5](https://github.com/jonahoffline/link_shrink/tree/v0.0.5)).

data/README.md

@@ -8,6 +8,7 @@ A Ruby Gem and Command-Line Application for shrinking those long and nasty links
 * Google
 * TinyUrl
 * IsGd
+* Owly
 * **More to come...**
 
 Installation
@@ -19,6 +20,7 @@ Installation
 Setup
 -------
 
+## Google
 Works best with a Google URL API key. You can sign-up for a free one at
 [Google URL API](https://code.google.com/apis/console)
 
@@ -28,14 +30,22 @@ if the Terms of Service appear, read and accept them.
 2. Go to the [API Access pane](https://code.google.com/apis/console#access). The API key is near the bottom of that pane,
 in the section titled "Simple API Access."
 
-#### Configuration ####
+## Owly
+Sign-up for a free API key at [Owly](http://ow.ly/).
 
-Set your key as an environment variable:
+
+#### Configuration
+
+Set your apikey as an environment variable:
 
     $ export GOOGLE_URL_KEY='your_api_key_here'
+   
+    
+    $ export OWLY_URL_KEY='your_api_key_here'
 
 You could also save it in your ~/.bash_profile
 
+
 ## Usage ##
 
 Ruby:
@@ -88,12 +98,17 @@ In your terminal:
 
     $ linkshrink --isgd http://www.rubyrogues.com
     http://is.gd/6ZNRWe
+    
+    $ linkshrink --owly http://www.rubyrogues.com
+    http://ow.ly/22rwSe
+    
 ### Command-Line Options ###
 
 Shrinkers:
 
   * -t, --tinyurl     - use TinyUrl API
   * -i, --isgd		   - use Is.gd API
+  * -om --owly        - use Owly API
   * -g, --google      - use Google API (Default) 
 
 Format and additional options:

data/lib/link_shrink/cli.rb

@@ -19,6 +19,7 @@ module LinkShrink
       @tiny_url    = false
       @google      = false
       @is_gd       = false
+      @owly        = false
       opts.version = LinkShrink::VERSION
       opts.banner  = <<MSG
 Usage: link_shrink [OPTION] [URL]
@@ -36,6 +37,10 @@ MSG
         @is_gd = :true
       end
 
+      opts.on_head('-o', '--owly', 'use Owly') do
+        @owly = :true
+      end
+
       opts.on_head('-g', '--google', 'use Google (Default)') do
         @google = :true
       end
@@ -84,6 +89,8 @@ MSG
           'TinyUrl'
         when @is_gd
           'IsGd'
+        when @owly
+          'Owly'
         else
           'Google'
       end

data/lib/link_shrink/request.rb

@@ -22,10 +22,18 @@ module LinkShrink
       end
     end
 
+    def process_parse_options(parsed_json, shrinker)
+      if shrinker.collection_key && shrinker.url_key
+        parsed_json.fetch(shrinker.collection_key).fetch(shrinker.url_key)
+      else
+        parsed_json.fetch(shrinker.url_key)
+      end
+    end
+
     def process_response(response, options, shrinker, json = JSONParser)
       option      = Options.new(options)
       parsed_json = json.parse_json(response)
-      plain       = parsed_json['id']
+      plain       = process_parse_options(parsed_json, shrinker.class)
 
       if option.json? && option.qr_code?
         if option.image_size?

data/lib/link_shrink/shrinkers/base.rb

@@ -84,6 +84,28 @@ module LinkShrink
       def generate_chart_url(new_url, image_size = {})
         fail "#{__method__} not implemented"
       end
+
+      # Handles DSL definition of response structure to be parsed (JSON)
+      class << self
+        attr_accessor :collection_key, :url_key
+
+        # Helper method that yields into the other response structure methods
+        def response_options(&block)
+          yield
+        end
+
+        # Defines collection_key in response
+        # @param new_collection [String] collection_key
+        def collection(new_collection)
+          self.collection_key = new_collection
+        end
+
+        # Defines url_key in response
+        # @param new_url_key [String] url_key
+        def short_url(new_url_key)
+          self.url_key = new_url_key
+        end
+      end
     end
   end
 end

data/lib/link_shrink/shrinkers/google.rb

@@ -5,6 +5,11 @@ module LinkShrink
     # @author Jonah Ruiz <jonah@pixelhipsters.com>
     # Implements Google's URL Shortener API
     class Google < Base
+      # Defines response structure to be parsed
+      response_options do
+        short_url  'id'
+      end
+
       # Returns URL base for API
       # @return [String] api base url
       def base_url

data/lib/link_shrink/shrinkers/owly.rb

@@ -0,0 +1,33 @@
+require 'json'
+
+module LinkShrink
+  module Shrinkers
+    # @author Jonah Ruiz <jonah@pixelhipsters.com>
+    # Implements Owly's URL Shortener API
+    class Owly < Base
+      # Defines response structure to be parsed
+      response_options do
+        collection 'results'
+        short_url  'shortUrl'
+      end
+
+      # Returns URL base for API
+      # @return [String] api base url
+      def base_url
+        'http://ow.ly/api/1.1/url/shorten'
+      end
+
+      # Returns URL query parameters
+      # @return [String] query parameters to be used in request
+      def api_query_parameter
+        "?apiKey=#{api_key}&longUrl=#{url}"
+      end
+
+      # Returns full api url
+      # @return [String] full api url with query parameters
+      def api_url
+        base_url.concat api_query_parameter
+      end
+    end
+  end
+end

data/lib/link_shrink/version.rb

@@ -1,3 +1,3 @@
 module LinkShrink
-  VERSION = '0.0.5'
+  VERSION = '0.0.6'
 end

data/lib/link_shrink.rb

@@ -6,6 +6,7 @@ require 'link_shrink/shrinkers/base'
 require 'link_shrink/shrinkers/google'
 require 'link_shrink/shrinkers/tinyurl'
 require 'link_shrink/shrinkers/isgd'
+require 'link_shrink/shrinkers/owly'
 require 'link_shrink/config'
 
 # @author Jonah Ruiz <jonah@pixelhipsters.com>

data/spec/link_shrink/google_spec.rb

@@ -50,4 +50,16 @@ describe LinkShrink::Shrinkers::Google do
       .to eq("{\"longUrl\":\"http://www.google.com\"}")
     end
   end
-end
+
+  describe '#collection_key' do
+    it 'returns nil' do
+      expect(link_shrink.class.collection_key).to eq(nil)
+    end
+  end
+
+  describe '#url_key' do
+    it 'returns key used to extract data from response' do
+      expect(link_shrink.class.url_key).to eq('id')
+    end
+  end
+end

data/spec/link_shrink/owly_spec.rb

@@ -0,0 +1,71 @@
+require 'spec_helper'
+
+describe LinkShrink::Shrinkers::Owly do
+  include_examples 'shared_examples'
+
+  let(:link_shrink) { described_class.new }
+  let(:owly) { 'http://ow.ly/api/1.1/url/shorten' }
+  let(:key) { ENV['OWLY_URL_KEY'] }
+
+  describe '#sub_klass' do
+    it 'returns the inherited subclass name' do
+      expect(link_shrink.sub_klass).to eq('Owly')
+    end
+  end
+
+  describe '#base_url' do
+    it 'returns the base_url for the API' do
+      expect(link_shrink.base_url)
+      .to eq(owly)
+    end
+  end
+
+  describe '#api_key' do
+    it 'returns the API key' do
+      expect(link_shrink.api_key)
+      .to eq(key)
+    end
+  end
+
+  describe '#api_url' do
+    it 'returns full api url' do
+      link_shrink.stub(:url).and_return('http://www.google.com')
+
+      expect(link_shrink.api_url)
+      .to eq("http://ow.ly/api/1.1/url/shorten?apiKey=#{key}&longUrl=http://www.google.com")
+    end
+  end
+
+  describe '#api_query_parameter' do
+    it 'returns query parameter' do
+      link_shrink.stub(:url).and_return('http://www.google.com')
+      expect(link_shrink.api_query_parameter).to eq("?apiKey=#{key}&longUrl=http://www.google.com")
+    end
+  end
+
+  describe '#content_type' do
+    it 'returns text/plain' do
+      expect(link_shrink.content_type).to eq('application/json')
+    end
+  end
+
+  describe '#collection_key' do
+    it 'returns key of collection' do
+      expect(link_shrink.class.collection_key).to eq('results')
+    end
+  end
+
+  describe '#url_key' do
+    it 'returns key used to extract data from response' do
+      expect(link_shrink.class.url_key).to eq('shortUrl')
+    end
+  end
+
+  context 'integration' do
+    it 'returns correct shortUrl' do
+      LinkShrink.configure { |config| config.api = 'Owly' }
+      expect(LinkShrink.shrink_url('www.google.com'))
+      .to eq('http://ow.ly/22rqvf')
+    end
+  end
+end

data/spec/link_shrink/shrinker_base_spec.rb

@@ -108,4 +108,15 @@ describe LinkShrink::Shrinkers::Base do
       end
     end
   end
-end
+
+  describe '#collection_key' do
+    it 'returns nil' do
+      expect(link_shrink.class.collection_key).to eq(nil)
+    end
+  end
+  describe '#url_key' do
+    it 'returns key used to extract data from response' do
+      expect(link_shrink.class.url_key).to eq(nil)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link_shrink
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 0.0.6
   prerelease: 
 platform: ruby
 authors:
@@ -184,6 +184,7 @@ files:
 - lib/link_shrink/shrinkers/base.rb
 - lib/link_shrink/shrinkers/google.rb
 - lib/link_shrink/shrinkers/isgd.rb
+- lib/link_shrink/shrinkers/owly.rb
 - lib/link_shrink/shrinkers/tinyurl.rb
 - lib/link_shrink/version.rb
 - link_shrink.gemspec
@@ -196,6 +197,7 @@ files:
 - spec/link_shrink/json_parser_spec.rb
 - spec/link_shrink/link_shrink_spec.rb
 - spec/link_shrink/options_spec.rb
+- spec/link_shrink/owly_spec.rb
 - spec/link_shrink/request_spec.rb
 - spec/link_shrink/shrinker_base_spec.rb
 - spec/link_shrink/tiny_url_spec.rb
@@ -232,7 +234,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -545326906188575545
+      hash: -2671621547158005072
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -249,6 +251,7 @@ test_files:
 - spec/link_shrink/json_parser_spec.rb
 - spec/link_shrink/link_shrink_spec.rb
 - spec/link_shrink/options_spec.rb
+- spec/link_shrink/owly_spec.rb
 - spec/link_shrink/request_spec.rb
 - spec/link_shrink/shrinker_base_spec.rb
 - spec/link_shrink/tiny_url_spec.rb