link_shrink 0.0.7 → 0.0.8

data/.travis.yml

@@ -16,3 +16,5 @@ env:
   global:
   - secure: bPqqN6twAJeRIpUEGozFIV3+dW2TSRxYQRrQhpzJ6Bx2ZXmk8UWl1O57Scf9/ZrCjo23MSvWKY1Rt1eyncaUVfzr4PjR6GjUwwdE7SPHQFKvGeNLIlJElzcz1ywcX6RU8+6JPYnx3NxR2O5VM8rf7wLwma00nuaDunM5NgKMMdQ=
   - secure: JfAnh3FV1Q5Sz+QydZ7hFCCvCTiJoYqM4h0ztzZU/fqDNKo6d1/h8RWGZL++d7Ofl3Z7Jrfbj/1R4f8UiwNJVdqRMPgSrbbif8LfVBmsTtZm/gFcL5WFhm/kzIi7Jp7FmzNQc6Hx+EiI3T2mtLw51fi7lNNonVhevyEetUSvG2Q=
+  - secure: DLNt3OAr07xhgYc7Ju1qVSAeykaz9tOgdG0ya6VVRK7cUmJYzHhMWQErvixgEMnInJoGgdJPe8Bg9NdCrYTxk8gF6sCPAyK2g28NJSiqfkPSMUgS70r/YdcGISjTC+k9H2chB034qN0JDfWYg8tY4l69JB7sCtApBlIfjmK4Aso=
+  - secure: QpcuL9NkCD1MP/gJsrnlfnIMV7p9uARHNM5uPnumBYeisd0QCrt1gLBz5fGBpqbMF/peK5cnCVYbjRyteAygKi4sy/CfiA+YqIIPs72Gn2OvZKOWkwvq7UT0oMBhSrF+NGwX7JVSQRgeOqJFpVnkpp5ddW13e27ho/nuOcz3rTs=

data/Changelog.md

@@ -1,5 +1,12 @@
 # LinkShrink Changelog
 
+## 0.0.8
+
+Released January 19, 2014 ([0.0.7](https://github.com/jonahoffline/link_shrink/tree/v0.0.8)).
+
+* Add Karmacracy Shrinker (available automatically in the command-line)
+* Update version to 0.0.8
+
 ## 0.0.7
 
 Released January 19, 2014 ([0.0.7](https://github.com/jonahoffline/link_shrink/tree/v0.0.7)).

data/README.md

@@ -9,6 +9,7 @@ A Ruby Gem and Command-Line Application for shrinking those long and nasty links
 * TinyUrl
 * IsGd
 * Owly
+* Karmacracy
 * **More to come...**
 
 ## Installation
@@ -19,8 +20,7 @@ A Ruby Gem and Command-Line Application for shrinking those long and nasty links
 
 ## Setup
 
-You can use any shrinker listed without worrying about the api key except for 'Owly'.
-Google let's you use its api without an api key, but providing one will generate metrics in their dashboard.
+You can use any shrinker listed without worrying about the api key except for **Owly** and **Karmacracy**. Google let's you use its api without an api key, but providing one will generate metrics in their dashboard.
 
 ## Google
 Works best with a Google URL API key. You can sign-up for a free one at
@@ -35,6 +35,8 @@ in the section titled "Simple API Access."
 ## Owly
 Sign-up for a free API key at [Owly](http://ow.ly/).
 
+## Karmacracy
+Sign-up for a free API key at [Karmacracy](http://karmacracy.com/).
 
 #### Configuration
 
@@ -43,6 +45,9 @@ Set your apikey as an environment variable:
     $ export GOOGLE_URL_KEY='your_api_key_here'
     
     $ export OWLY_URL_KEY='your_api_key_here'
+    
+    $ export KARMACRACY_URL_KEY='your_api_key_here'
+    $ export KARMACRACY_USERNAME='your_username_here'
 
 You could also save it in your `~/.bash_profile` or `~/.zshrc`
 
@@ -98,7 +103,8 @@ Shrinkers:
   * -t, --tinyurl     - use TinyUrl API
   * -i, --isgd		   - use Is.gd API
   * -om --owly        - use Owly API
-  * -g, --google      - use Google API (Default) 
+  * -g, --google      - use Google API (Default)
+  * -k  --karmacracy  - use Karmacracy API
 
 Additional options:
 

data/lib/link_shrink.rb

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

data/lib/link_shrink/shrinkers/karmacracy.rb

@@ -0,0 +1,47 @@
+module LinkShrink
+  module Shrinkers
+    # @author Jonah Ruiz <jonah@pixelhipsters.com>
+    # Implements Karmacracy's URL Shortener API
+    class Karmacracy < Base
+      # Defines response structure to be parsed
+      response_options do
+        collection 'data'
+        short_url  'url'
+      end
+
+      # Returns URL base for API
+      # @return [String] api base url
+      def base_url
+        'http://kcy.me/api/'
+      end
+
+      # Returns URL query parameters
+      # @return [String] query parameters to be used in request
+      def api_query_parameter
+        "?u=#{api_username}&key=#{api_key}&format=json&url=#{url}"
+      end
+
+      # Returns full api url
+      # @return [String] full api url with query parameters
+      def api_url
+        base_url.concat api_query_parameter
+      end
+
+      # Predicate method for checking if the API key exists
+      # @return [TrueClass, FalseClass]
+      def api_username?
+        ENV.has_key?("#{sub_klass.upcase}_USERNAME")
+      end
+
+      # Returns API Key
+      # @return [String] API key or nil
+      def api_username
+        api_username? ? ENV["#{sub_klass.upcase}_USERNAME"] : nil
+      end
+
+      def sanitize_url(new_url)
+        URI::encode(new_url)
+      end
+    end
+  end
+end

data/lib/link_shrink/version.rb

@@ -1,3 +1,3 @@
 module LinkShrink
-  VERSION = '0.0.7'
+  VERSION = '0.0.8'
 end

data/spec/link_shrink/shrinkers/karmacracy_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe LinkShrink::Shrinkers::Karmacracy do
+  include_examples 'shared_examples'
+
+  let(:link_shrink) { described_class.new }
+  let(:karmacracy) { 'http://kcy.me/api/' }
+  let(:key) { ENV['KARMACRACY_URL_KEY'] }
+  let(:username) { ENV['KARMACRACY_USERNAME'] }
+  let(:long_url) { 'http://www.google.com' }
+
+  describe '#sub_klass' do
+    it 'returns the inherited subclass name' do
+      expect(link_shrink.sub_klass).to eq('Karmacracy')
+    end
+  end
+
+  describe '#base_url' do
+    it 'returns the base_url for the API' do
+      expect(link_shrink.base_url).to eq(karmacracy)
+    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(long_url)
+      url ="#{karmacracy}?u=#{username}&key=#{key}&format=json&url=#{long_url}"
+
+      expect(link_shrink.api_url).to eq(url)
+    end
+  end
+
+  describe '#api_query_parameter' do
+    it 'returns query parameter' do
+      link_shrink.stub(:url).and_return(long_url)
+
+      expect(link_shrink.api_query_parameter)
+        .to eq("?u=#{username}&key=#{key}&format=json&url=#{long_url}")
+    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('data')
+    end
+  end
+
+  describe '#url_key' do
+    it 'returns key used to extract data from response' do
+      expect(link_shrink.class.url_key).to eq('url')
+    end
+  end
+
+  context 'integration' do
+    it 'returns correct shortUrl' do
+      link_shrink.stub(:url).and_return(long_url)
+      LinkShrink.configure { |config| config.api = 'Karmacracy' }
+
+      expect(LinkShrink.shrink_url('www.google.com'))
+        .to eq('http://kcy.me/x3o2')
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: link_shrink
 version: !ruby/object:Gem::Version
-  version: 0.0.7
+  version: 0.0.8
   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/karmacracy.rb
 - lib/link_shrink/shrinkers/owly.rb
 - lib/link_shrink/shrinkers/tinyurl.rb
 - lib/link_shrink/util.rb
@@ -199,6 +200,7 @@ files:
 - spec/link_shrink/request_spec.rb
 - spec/link_shrink/shrinkers/google_spec.rb
 - spec/link_shrink/shrinkers/isgd_spec.rb
+- spec/link_shrink/shrinkers/karmacracy_spec.rb
 - spec/link_shrink/shrinkers/owly_spec.rb
 - spec/link_shrink/shrinkers/shrinker_base_spec.rb
 - spec/link_shrink/shrinkers/tiny_url_spec.rb
@@ -235,7 +237,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4473325036172331892
+      hash: 2601120498495095577
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.25
@@ -253,6 +255,7 @@ test_files:
 - spec/link_shrink/request_spec.rb
 - spec/link_shrink/shrinkers/google_spec.rb
 - spec/link_shrink/shrinkers/isgd_spec.rb
+- spec/link_shrink/shrinkers/karmacracy_spec.rb
 - spec/link_shrink/shrinkers/owly_spec.rb
 - spec/link_shrink/shrinkers/shrinker_base_spec.rb
 - spec/link_shrink/shrinkers/tiny_url_spec.rb