link_shrink 0.0.2 → 0.0.3

data/.rspec

@@ -1,3 +1,3 @@
 --color
 --format documentation
---format Nc
+--fail-fast

data/.travis.yml

@@ -2,6 +2,8 @@
 language: ruby
 rvm:
 - 1.9.3
+- 2.0.0
+- jruby-19mode
 script: bundle exec rake test
 notifications:
   email: false

data/Changelog.md

@@ -1,5 +1,18 @@
 # LinkShrink Changelog
 
+## 0.0.3
+
+Released September 6, 2013 ([0.0.3](https://github.com/jonahoffline/link_shrink/tree/v0.0.3)).
+
+* Add Coverall gem to gemspec.
+* Add Config class for configuring Shrinker API to use.
+* Add TinyURL Shrinker.
+* Add documentation to TinyUrl, Google and Base class.
+* Add new options for command-line application.
+* Update README.
+* Refactor Shrinker Base class and the Google class.
+* Added 2.0 and JRuby support through TravisCI.
+
 ## 0.0.2
 
 Released July 16, 2013 ([0.0.2](https://github.com/jonahoffline/link_shrink/tree/v0.0.2)).

data/README.md

@@ -8,6 +8,27 @@ Installation
 
     $ gem install link_shrink
 
+
+Setup
+-------
+
+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)
+
+1. In the Services pane, activate the Google URL Shortener API;
+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 ####
+
+Set your key as an environment variable:
+
+    $ export GOOGLE_URL_KEY='your_api_key_here'
+
+You could also save it in your ~/.bash_profile
+
 ## Usage ##
 
 Ruby:
@@ -29,6 +50,25 @@ LinkShrink.shrink_url("http://www.ruby-lang.org", { :qr_code => true, image_size
 
 LinkShrink.shrink_url("http://www.ruby-lang.org", { json: true, qr_code: true, image_size: '300x300' })
 => "{\"kind\":\"urlshortener#url\",\"id\":\"http://goo.gl/MprR\",\"longUrl\":\"http://www.ruby-lang.org/\",\"qr_code\":\"http://chart.googleapis.com/chart?cht=qr&chs=300x300&choe=UTF-8&chld=H&chl=http://goo.gl/MprR\"}"
+
+```
+
+To change the default shrinker (Google API):
+
+
+```ruby
+LinkShrink.configure do |c|
+  c.api = 'TinyUrl'
+end
+
+# or
+
+LinkShrink::Config.api = 'TinyUrl'
+
+LinkShrink.shrink_url('http://www.google.com')
+=> "http://tinyurl.com/1c2"
+
+
 ```
 
 
@@ -36,9 +76,14 @@ In your terminal:
 
     $ linkshrink http://www.rubyrogues.com
     http://goo.gl/Noh9X
+    
+    $ linkshrink --tinyurl http://www.rubyrogues.com
+    http://tinyurl.com/k2butj9
 
 ### Command-Line Options ###
 
+  * -t, --tinyurl     - use TinyUrl API
+  * -g, --google      - use Google API (Default)
   * -j, --json        - return JSON response
   * -q, --qrcode      - return QR Code
   * -h, --help        - show help message

data/lib/link_shrink/cli.rb

@@ -13,8 +13,11 @@ module LinkShrink
     # Configures the arguments for the command
     # @param opts [OptionParser]
     def set_options(opts)
+      %w(@json @qr_code @tiny_url)
       @json        = false
       @qr_code     = false
+      @tiny_url    = false
+      @google      = false
       opts.version = LinkShrink::VERSION
       opts.banner  = <<MSG
 Usage: link_shrink [OPTION] [URL]
@@ -24,12 +27,20 @@ Description:
 Options:
 MSG
       opts.set_program_name 'LinkShrink'
+      opts.on_head('-t', '--tinyurl', 'use TinyURL') do
+        @tiny_url = :true
+      end
+
+      opts.on_head('-g', '--google', 'use Google (Default)') do
+        @google = :true
+      end
+
       opts.on_head('-j', '--json', 'return JSON response') do
         @json = :true
       end
 
       opts.on_head('-q', '--qrcode', 'return QR Code') do
-        @qr_code = :true
+        @qr_code = :true unless @tiny_url
       end
 
       opts.on_tail('-v', '--version', 'display the version of LinkShrink and exit') do
@@ -53,11 +64,12 @@ MSG
     end
 
     def process_url
+      LinkShrink.configure { |c| c.api = 'TinyUrl' } if @tiny_url
       LinkShrink.shrink_url(@args.last, { json: @json, qr_code: @qr_code })
     end
 
     def url_present?
-      !!(@args.last =~ /^(https?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/)
+      !!(@args.last =~ /^(http?:\/\/)?([\da-z\.-]+)\.([a-z\.]{2,6})([\/\w \.-]*)*\/?$/)
     end
   end
-end
+end

data/lib/link_shrink/config.rb

@@ -0,0 +1,24 @@
+module LinkShrink
+  module Config
+    # @author Jonah Ruiz <jonah@pixelhipsters.com>
+    # Configurable module for integrating with other URL APIs
+    extend self
+
+    # Returns and Sets API key to be used
+    # @param api_key [String] API key to be used
+    attr_accessor :api_key
+
+    # Sets API to be used
+    # @param api [String or Symbol] api to be used
+    def api=(api)
+      @api = LinkShrink::Shrinkers.const_get(api).new
+    end
+
+    # Returns API used
+    # Unless an API is defined, it returns Google by default
+    # @return [LinkShrink::Shrinkers::Google] instance
+    def api
+      @api || LinkShrink::Shrinkers::Google.new
+    end
+  end
+end

data/lib/link_shrink/request.rb

@@ -10,11 +10,12 @@ module LinkShrink
 
     module_function
 
-    def process_request(url, options, shrinker = LinkShrink::Shrinkers::Google.new)
+    def process_request(url, options, shrinker = LinkShrink::Config.api)
       process_response(request(url, shrinker).body, options, shrinker)
     end
 
     def process_response(response, options, shrinker, json = JSONParser)
+      return response if shrinker.content_type.eql?('text/plain')
       option      = Options.new(options)
       parsed_json = json.parse_json(response)
       plain       = parsed_json['id']
@@ -45,11 +46,12 @@ module LinkShrink
     # @see LinkShrink::Shrinkers::Base#api_url
     # @see LinkShrink::Shrinkers::Base#body_parameters
     def request(url, shrinker)
+      shrinker.url = url
       Typhoeus::Request.new(
         shrinker.api_url,
-        method:  :post,
+        method:  shrinker.http_method,
         body:    shrinker.body_parameters(url),
-        headers: { 'Content-Type' => 'application/json' }
+        headers: { 'Content-Type' => shrinker.content_type }
       ).run
     end
   end

data/lib/link_shrink/shrinkers/base.rb

@@ -5,11 +5,14 @@ module LinkShrink
     # @author Jonah Ruiz <jonah@pixelhipsters.com>
     # an Abstract Base class for implementing other URL APIs
     class Base
+      attr_reader :url
       # Callback method that dynamically defines a sub_klass method for reference
       # @return [String] inherited class name
       def self.inherited(sub_klass)
-        define_method 'sub_klass' do
-          "#{sub_klass.name}"[/::(\w+)::(\w+)/, 2]
+        sub_klass.class_eval do
+          define_method 'sub_klass' do
+            @sub_klass = "#{sub_klass.name}"[/::(\w+)::(\w+)/, 2]
+          end
         end
       end
 
@@ -24,8 +27,10 @@ module LinkShrink
       end
 
       # Parameters to be used in API request
-      def body_parameters(url)
-        fail "#{__method__} not implemented"
+      # @param params [Hash] parameters to be used
+      # @return [NilClass] nil if parameters are empty
+      def body_parameters(params = {})
+        nil if params.empty?
       end
 
       # Complete URL with query parameters
@@ -46,8 +51,38 @@ module LinkShrink
       end
 
       # Encodes URL
-      def sanitize_url(url)
-        URI.encode(url)
+      # @param new_url [String] url to be parsed
+      # @return [String] parsed URL
+      def sanitize_url(new_url)
+        URI.encode(!(new_url =~ /^(http?:\/\/)?/) ? "http://#{new_url}" : new_url)
+      end
+
+      # Returns HTTP method to be used in request
+      # @return [Symbol] http method
+      def http_method
+        :get
+      end
+
+      # Returns Content-Type to be used in Request headers
+      # @return [String] content-type
+      def content_type
+        'application/json'
+      end
+
+      # Sets URL to be used in request
+      # @see #sanitize_url
+      # @param new_url [String] url to be parsed
+      # @return [String] parsed url
+      def url=(new_url)
+        @url = sanitize_url(new_url)
+      end
+
+      # Method for generating QR codes or charts
+      # @param new_url [String] url to be processed
+      # @param image_size [Hash<symbol>] image size target
+      # @return [String] chart or qr code url
+      def generate_chart_url(new_url, image_size = {})
+        fail "#{__method__} not implemented"
       end
     end
   end

data/lib/link_shrink/shrinkers/google.rb

@@ -5,27 +5,39 @@ module LinkShrink
     # @author Jonah Ruiz <jonah@pixelhipsters.com>
     # Implements Google's URL Shortener API
     class Google < Base
+      # Returns URL base for API
+      # @return [String] api base url
       def base_url
         'https://www.googleapis.com/urlshortener/v1/url'
       end
 
+      # Returns URL query parameters
+      # @return [String] query parameters to be used in request
       def api_query_parameter
         "?key=#{api_key}"
       end
 
-      def body_parameters(url)
-        { 'longUrl' => sanitize_url(url) }.to_json
+      # Returns body parameters used in request header
+      # @return [String] body parameters to be used in request header
+      def body_parameters(new_url = nil)
+        { 'longUrl' => url }.to_json
       end
 
       # Generates QR code URL
       # @return [String] QR code url with '150x150' or custom image size
-      def generate_chart_url(url, image_size = {})
-        return "#{url}.qr" if image_size.empty?
+      def generate_chart_url(new_url, image_size = {})
+        return "#{new_url}.qr" if image_size.empty?
 
         chart_url = 'http://chart.googleapis.com/chart'
-        params    = "?cht=qr&chs=#{image_size}&choe=UTF-8&chld=H&chl=#{url}"
+        params    = "?cht=qr&chs=#{image_size}&choe=UTF-8&chld=H&chl=#{new_url}"
         chart_url.concat(params)
       end
+
+      # Returns HTTP method to be used in request
+      # @return [Symbol] post http method
+      def http_method
+        :post
+      end
     end
   end
-end
+end

data/lib/link_shrink/shrinkers/tinyurl.rb

@@ -0,0 +1,31 @@
+module LinkShrink
+  module Shrinkers
+    # @author Jonah Ruiz <jonah@pixelhipsters.com>
+    # Implements Tiny URL Shortener API
+    class TinyUrl < Base
+      # Returns URL base for API
+      # @return [String] api base url
+      def base_url
+        'http://tinyurl.com/api-create.php'
+      end
+
+      # URL query parameters
+      # @return [String] query parameters to be used in request
+      def api_query_parameter
+        "?url=#{url}"
+      end
+
+      # Returns Content-Type to be used in Request headers
+      # @return [String] text/plain as content-type
+      def content_type
+        'text/plain'
+      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.2'
+  VERSION = '0.0.3'
 end

data/lib/link_shrink.rb

@@ -4,10 +4,13 @@ require 'link_shrink/request'
 require 'link_shrink/json_parser'
 require 'link_shrink/shrinkers/base'
 require 'link_shrink/shrinkers/google'
+require 'link_shrink/shrinkers/tinyurl'
+require 'link_shrink/config'
 
 # @author Jonah Ruiz <jonah@pixelhipsters.com>
 # Creates a short URL and QR codes
 module LinkShrink
+  extend self
   include LinkShrink::Request
   # Returns a short URL or JSON response
   #   example: shrink_url('http://www.wtf.com', { json: true, qr_code: true })
@@ -16,7 +19,7 @@ module LinkShrink
   # @param url [String] long URL to be shortened
   # @param options [Hash] format to be returned
   # @return [String] generated short URL or JSON response
-  def self.shrink_url(url, options = { json: false, qr_code: false })
+  def shrink_url(url, options = { json: false, qr_code: false })
     process_request(url, options)
   rescue
     'Problem generating short URL. Try again.'
@@ -28,9 +31,17 @@ module LinkShrink
   # @param url [String] long URL to be shortened
   # @param options [Hash] image_size: '300x300' for a custom size
   # @return [String] QR code URL using default or custom size
-  def self.generate_qr_code(url, options = {})
+  def generate_qr_code(url, options = {})
     new_url    = process_request(url, {})
     image_size = options.fetch(:image_size, {})
-    LinkShrink::Shrinkers::Google.new.generate_chart_url(new_url, image_size)
+    Config.api.generate_chart_url(new_url, image_size)
+  end
+
+  # Yield's to Config for options
+  #
+  # @param <config> [String] api interface to use
+  # @param <api_key> [String] api key to use
+  def configure
+    yield LinkShrink::Config if block_given?
   end
 end

data/link_shrink.gemspec

@@ -24,9 +24,9 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'rspec', '~> 2.14.1'
   spec.add_development_dependency 'rake'
-  spec.add_development_dependency 'autotest-standalone', '~> 4.5.11'
-  spec.add_development_dependency 'autotest-fsevent', '~> 0.2.8'
-  spec.add_development_dependency 'rspec-nc', '~> 0.0.6'
   spec.add_development_dependency 'simplecov', '~> 0.7.1'
   spec.add_development_dependency 'simplecov-gem-adapter', '~> 1.0.1'
-end
+  spec.add_development_dependency 'coveralls', '~> 0.6.7'
+  spec.add_development_dependency 'webmock', '~> 1.13.0'
+  spec.add_development_dependency 'vcr', '~> 2.5.0'
+end

data/spec/link_shrink/config_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe LinkShrink::Config do
+  include_examples 'shared_examples'
+
+  let(:link_shrink) { described_class }
+
+  describe '#api_key' do
+    it 'sets api_key' do
+      link_shrink.api_key = '12345'
+      expect(link_shrink.api_key).to eq('12345')
+    end
+  end
+
+  describe '#api' do
+    it 'sets api' do
+      link_shrink = LinkShrink
+      link_shrink.configure { |c| c.api = 'Google' }
+      expect(link_shrink::Config.api.class).to eq(LinkShrink::Shrinkers::Google)
+    end
+
+    context 'by default api is set to Google' do
+      it 'returns api name' do
+        expect(link_shrink.api).to be_a(LinkShrink::Shrinkers::Google)
+      end
+    end
+  end
+
+end

data/spec/link_shrink/google_spec.rb

@@ -45,7 +45,8 @@ describe LinkShrink::Shrinkers::Google do
 
   describe '#body_parameters' do
     it 'returns body parameters for API request' do
-      expect(link_shrink.body_parameters("http://www.google.com"))
+      link_shrink.stub(:url).and_return('http://www.google.com')
+      expect(link_shrink.body_parameters())
       .to eq("{\"longUrl\":\"http://www.google.com\"}")
     end
   end

data/spec/link_shrink/link_shrink_spec.rb

@@ -3,7 +3,7 @@ require 'spec_helper'
 describe LinkShrink do
   include_examples 'shared_examples'
 
-  describe '.shrink_url' do
+  describe '.shrink_url', :vcr => 'google_url' do
     it 'creates a short url' do
       expect(link_shrink.shrink_url(url)).to eq(short_url)
     end
@@ -52,14 +52,30 @@ describe LinkShrink do
       end
     end
 
+    context 'when called with no qr_code and image_size: 200x200' do
+      it 'returns QR code link with custom size' do
+        expect(link_shrink.shrink_url(url, {:image_size => "200x200"}))
+        .to eq(chart_url)
+      end
+    end
+
     context 'when called with json, qr_code and image_size: 300x300' do
-      let(:options) { { json: true, qr_code: true, image_size: "300x300" }}
+      let(:options) { { json: true, qr_code: true, image_size: "300x300" } }
 
       it 'returns QR code in JSON with custom size' do
         expect(link_shrink.shrink_url(url, options))
         .to eq(json_qr_code_custom)
       end
     end
+
+    context 'when API is down' do
+      it 'raises rescue exception' do
+        link_shrink.stub(:request).and_return(nil)
+
+        expect(link_shrink.shrink_url('www.google.com'))
+        .to eq('Problem generating short URL. Try again.')
+      end
+    end
   end
 
   describe '.generate_qr_code' do
@@ -74,4 +90,17 @@ describe LinkShrink do
       end
     end
   end
+
+  describe '.configure' do
+    context 'when passed a block' do
+      it 'yields to Config' do
+        expect { |c| link_shrink.configure(&c) }.to yield_control
+      end
+
+      it 'sets API Shrinker' do
+        link_shrink.should_receive(:configure).and_yield(LinkShrink::Config)
+        link_shrink.configure { |config| api = 'TinyURL' }
+      end
+    end
+  end
 end

data/spec/link_shrink/request_spec.rb

@@ -2,18 +2,15 @@ require 'spec_helper'
 
 describe LinkShrink::Request do
   include_examples 'shared_examples'
-  let(:shrinker) { LinkShrink::Shrinkers::Google.new }
+  let(:shrinker) { LinkShrink::Config.api }
   let(:json_default) {{ :json => false }}
 
   describe '.process_request' do
     it 'calls request and returns short link' do
-      expect(link_shrink.process_request(url, json_default)).to eq(short_url)
+      expect(link_shrink.process_request(url, json_default, shrinker))
+      .to eq(short_url)
     end
 
-    #it 'calls request and returns short link' do
-    #  expect(link_shrink.process_request(url)).to eq(short_url)
-    #end
-
     context 'when called with qr_code true, image_size 300x300' do
       it 'returns QR code with custom size' do
         options = { json: true, qr_code: true, image_size: '300x300' }

data/spec/link_shrink/shrinker_base_spec.rb

@@ -16,28 +16,62 @@ describe LinkShrink::Shrinkers::Base do
   end
 
   describe '#body_parameters' do
-    it 'raises error due to other methods not being overridden' do
-      expect{ link_shrink.body_parameters }.to raise_error
+    it 'raises nil when called without arguments' do
+      expect(link_shrink.body_parameters).to eq(nil)
     end
   end
 
   describe '#api_url' do
+    context 'when api_key is found' do
+      it 'returns base_url with api_query_parameters' do
+        link_shrink.stub(:sub_klass).and_return('Blahblah')
+        link_shrink.stub(:api_key).and_return('12345')
+        link_shrink.stub(:api_key?).and_return(true)
+
+        link_shrink.stub(:base_url).and_return('http://blah.io/api')
+        link_shrink.stub(:api_query_parameter).and_return('?key=12345')
+        expect(link_shrink.api_url).to eq('http://blah.io/api?key=12345')
+      end
+    end
+
+    context 'when api_key is not found' do
+      it 'returns base_url' do
+        link_shrink.stub(:sub_klass).and_return('Blahblahblah')
+        link_shrink.stub(:api_key?).and_return(false)
+        link_shrink.stub(:base_url).and_return('http://blah.io/api')
+        expect(link_shrink.api_url).to eq('http://blah.io/api')
+      end
+    end
+  end
+
+  describe '#generate_chart_url' do
     it 'raises error due to other methods not being overridden' do
-      expect{ link_shrink.base_url }.to raise_error
+      expect{ link_shrink.generate_chart_url('something') }.to raise_error
     end
   end
-  #
+
   describe '#api_key?' do
     it 'returns false when API is not found' do
-      link_shrink.stub(:sub_klass).and_return('blahblah')
+      link_shrink.stub(:sub_klass).and_return('blahbla')
       expect(link_shrink.api_key?).to be_false
     end
   end
 
   describe '#api_key' do
-    it 'returns the api key' do
-      link_shrink.stub(:sub_klass).and_return('blahblah')
-      expect(link_shrink.api_key).to eq(nil)
+    context 'when not found' do
+      it 'returns nil' do
+        link_shrink.stub(:sub_klass).and_return('Blahh')
+        expect(link_shrink.api_key).to eq(nil)
+      end
+    end
+
+    context 'when found' do
+      it 'returns api_key' do
+        link_shrink.stub(:sub_klass).and_return('Blah')
+        #link_shrink.stub(:api).and_return('Blah')
+        ENV.store('BLAH_URL_KEY', '12345')
+        expect(link_shrink.api_key).to eq('12345')
+      end
     end
   end
 
@@ -47,4 +81,31 @@ describe LinkShrink::Shrinkers::Base do
       .to eq("http://www.google.com/%20")
     end
   end
+
+  describe '#http_method' do
+    it 'returns :get' do
+      expect(link_shrink.http_method).to eq(:get)
+    end
+  end
+
+  describe '#content_type' do
+    it 'returns application/json by default' do
+      expect(link_shrink.content_type).to eq('application/json')
+    end
+  end
+
+  describe '#url' do
+    context 'when set' do
+      it 'returns url' do
+        link_shrink.url = 'http://www.google.com'
+        expect(link_shrink.url).to eq('http://www.google.com')
+      end
+    end
+
+    context 'when called without being set' do
+      it 'returns nil' do
+        expect(link_shrink.url).to eq(nil)
+      end
+    end
+  end
 end