bitly_quickly 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 17cb39c19898b60d73e95bd5978331074f749ae8
+  data.tar.gz: 0a16234d8845c2cf02c3a847eb0aa22734eeb6ec
+SHA512:
+  metadata.gz: 8b9acad3207d9542f1a0d720256542e96a21f55c51e49d6d0163be891f16ad47e0a667a3f6f49aaa22f193b5c2b10f50c46ac6f112fc9e3fb48f07e7510db9d5
+  data.tar.gz: 796293f24eefd7cef97f2be42f855d67a8ea5a7b09a936193812616e2088de4807d7ae657b85cb57be8076e4f35afad7607f9051c8d39c7486f57fa364b44efe

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in bitly_quickly.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Oldrich Vetesnik
+
+MIT License
+
+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,35 @@
+# BitlyQuickly
+
+There are many great [bit.ly](https://bitly.com/) gems, it's just that I wanted something as fast and as simple as possible.
+It can only shorten URLs. :-)
+
+It uses [Quickly](https://github.com/typhoeus/typhoeus) which is an awesome HTTP library for fast
+and parallel networking. It also uses [Oj](https://github.com/ohler55/oj) which is a fast JSON parser.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'bitly_quickly'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install bitly_quickly
+
+## Usage
+
+    client         = BitlyQuickly.new(access_token: 'token')
+    shortened_url  = client.shorten('http://www.google.com/')
+    shortened_urls = client.shorten([
+      'https://www.google.com/',
+      'https://www.youtube.com/',
+      'https://www.yahoo.com/',
+    ])
+
+## Contributing
+
+You know the routine…

data/Rakefile

@@ -0,0 +1,7 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new 'spec'
+
+# If you want to make this the default task
+task default: :spec

data/bitly_quickly.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'bitly_quickly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'bitly_quickly'
+  spec.version       = BitlyQuickly::VERSION
+  spec.authors       = ['Oldrich Vetesnik']
+  spec.email         = ['oldrich.vetesnik@gmail.com']
+  spec.summary       = %q{Shorten URLs with bit.ly API}
+  spec.description   = %q{Shorten URLs with bit.ly API, make parallel requests.}
+  spec.homepage      = 'https://github.com/ollie/bitly_quickly'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler',   '~> 1.5'
+  spec.add_development_dependency 'rake',      '~> 10.1'
+  spec.add_development_dependency 'rspec',     '~> 2.14'
+  spec.add_development_dependency 'webmock',   '~> 1.17'
+  spec.add_development_dependency 'simplecov', '~> 0.8'
+
+  spec.add_runtime_dependency 'typhoeus', '~> 0.6'
+  spec.add_runtime_dependency 'oj',       '~> 2.5'
+end

data/lib/bitly_quickly.rb

@@ -0,0 +1,94 @@
+require 'typhoeus'
+require 'oj'
+
+require 'bitly_quickly/version'
+
+# V3 Wrapper
+class BitlyQuickly
+  class InvalidAccessToken < StandardError; end
+
+  DEFAULT_API_ADDRESS = 'https://api-ssl.bitly.com'
+  OJ_OPTIONS          = {
+    mode:             :compat,     # Converts values with to_hash or to_json
+    symbol_keys:      true,        # Symbol keys to string keys
+    time_format:      :xmlschema,  # ISO8061 format
+    second_precision: 0,           # No include milliseconds
+  }
+
+  attr_reader :access_token,
+              :api_address
+
+  def initialize(options)
+    @access_token = options.delete(:access_token) || raise( ArgumentError.new('Missing access_token option') )
+    @api_address  = options.delete(:api_address)  || DEFAULT_API_ADDRESS
+  end
+
+  def shorten(long_url_or_array)
+    if long_url_or_array.respond_to? :each
+      get_many_responses long_url_or_array
+    else
+      get_single_response long_url_or_array
+    end
+  end
+
+  def get_many_responses(array_of_long_urls)
+    hydra     = Typhoeus::Hydra.new
+    responses = []
+
+    array_of_long_urls.each do |long_url|
+      request = make_shorten_request long_url
+
+      request.on_complete do |response|
+        json_response = response_to_json response
+        responses << json_response[:data][:url]
+      end
+
+      hydra.queue request
+    end
+
+    hydra.run
+    responses
+  end
+
+  def get_single_response(long_url)
+    response = get_response long_url
+    response[:data][:url]
+  end
+
+  def api_url(path)
+    URI.join(api_address, path).to_s
+  end
+
+  def make_shorten_request(long_url)
+    Typhoeus::Request.new(
+      api_url('/v3/shorten'),
+      {
+        params: {
+          access_token: access_token,
+          longUrl:      long_url
+        },
+        headers: {
+          user_agent: 'Photolane.co'
+        }
+      }
+    )
+  end
+
+  def get_response(long_url)
+    request  = make_shorten_request long_url
+    response = request.run
+    response_to_json response
+  end
+
+  def response_to_json(response)
+    json_response = parse_response response
+
+    raise InvalidAccessToken if json_response[:status_txt] == 'INVALID_ARG_ACCESS_TOKEN'
+
+    json_response
+  end
+
+  def parse_response(response)
+    Oj.load response.body, OJ_OPTIONS
+  end
+end

data/lib/bitly_quickly/version.rb

@@ -0,0 +1,3 @@
+class BitlyQuickly
+  VERSION = '0.0.1'
+end

data/spec/lib/bitly_quickly_spec.rb

@@ -0,0 +1,95 @@
+require 'spec_helper'
+
+describe BitlyQuickly do
+  it 'fails to make a client' do
+    expect { BitlyQuickly.new }.to raise_error
+  end
+
+  context 'With access_token' do
+    before do
+      @client = BitlyQuickly.new access_token: 'token'
+    end
+
+    it 'access_token' do
+      expect(@client.access_token).to eq('token')
+    end
+
+    it 'api_address' do
+      expect(@client.api_address).to eq(BitlyQuickly::DEFAULT_API_ADDRESS)
+    end
+  end
+
+  context 'With access_token and api_address' do
+    before do
+      @client = BitlyQuickly.new access_token: 'token', api_address: 'http://api.bitly.com'
+    end
+
+    it 'api_address' do
+      expect(@client.api_address).to eq('http://api.bitly.com')
+    end
+  end
+
+  context 'Methods' do
+    before do
+      @client = BitlyQuickly.new access_token: 'token'
+    end
+
+    it 'api_url' do
+      expect(@client.api_url('/test')).to eq('https://api-ssl.bitly.com/test')
+    end
+
+    it 'makes request' do
+      expect(@client.make_shorten_request('http://www.google.com/1')).to be_kind_of(Typhoeus::Request)
+    end
+  end
+
+  context 'Response with invalid token' do
+    before do
+      @client = BitlyQuickly.new access_token: 'token'
+    end
+
+    it 'raises an execption' do
+      expect { @client.shorten('http://www.google.com/1') }.to raise_error
+    end
+  end
+
+  context 'Response with valid token' do
+    before do
+      @client = BitlyQuickly.new access_token: 'valid_token'
+    end
+
+    it 'raises an execption' do
+      expect { @client.shorten('http://www.google.com/1') }.to_not raise_error
+    end
+
+    it 'status code' do
+      expect(@client.shorten('http://www.google.com/1')).to eq('http://pht.io/1eyUhF1')
+    end
+  end
+
+  context 'Many requests' do
+    before do
+      @client = BitlyQuickly.new access_token: 'valid_token'
+    end
+
+    it 'makes many requests' do
+      request_urls = [
+        'http://www.google.com/1',
+        'http://www.google.com/2',
+        'http://www.google.com/3',
+        'http://www.google.com/4',
+        'http://www.google.com/5',
+      ]
+
+      response_urls = [
+        'http://pht.io/1eyUhF1',
+        'http://pht.io/1eyUhF2',
+        'http://pht.io/1eyUhF3',
+        'http://pht.io/1eyUhF4',
+        'http://pht.io/1eyUhF5',
+      ]
+
+      expect(@client.shorten(request_urls)).to eq(response_urls)
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,29 @@
+require 'simplecov'
+require 'webmock/rspec' # Disable all HTTP access
+
+# Coverage tool, needs to be started as soon as possible
+SimpleCov.start do
+  add_filter '/spec/' # Ignore spec directory
+end
+
+require 'bitly_quickly'
+
+RSpec.configure do |config|
+  config.before(:each) do
+    stub_request(:get, 'https://api-ssl.bitly.com/v3/shorten?access_token=token&longUrl=http://www.google.com/1').
+      with(headers: { 'User-Agent' => 'Photolane.co' }).
+      to_return(
+        status: 200,
+        body: '{ "data": [ ], "status_code": 500, "status_txt": "INVALID_ARG_ACCESS_TOKEN" }'
+      )
+
+    1.upto(5) do |n|
+      stub_request(:get, %(https://api-ssl.bitly.com/v3/shorten?access_token=valid_token&longUrl=http://www.google.com/#{ n })).
+        with(headers: { 'User-Agent' => 'Photolane.co' }).
+        to_return(
+          status: 200,
+          body: %({ "status_code": 200, "status_txt": "OK", "data": { "long_url": "http:\/\/www.google.com\/#{ n }", "url": "http:\/\/pht.io\/1eyUhF#{ n }", "hash": "1eyUhFo", "global_hash": "2V6CFi", "new_hash": 0 } })
+        )
+    end
+  end
+end

metadata

@@ -0,0 +1,156 @@
+--- !ruby/object:Gem::Specification
+name: bitly_quickly
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Oldrich Vetesnik
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-01-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.14'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: typhoeus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: oj
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+description: Shorten URLs with bit.ly API, make parallel requests.
+email:
+- oldrich.vetesnik@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bitly_quickly.gemspec
+- lib/bitly_quickly.rb
+- lib/bitly_quickly/version.rb
+- spec/lib/bitly_quickly_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ollie/bitly_quickly
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.1
+signing_key: 
+specification_version: 4
+summary: Shorten URLs with bit.ly API
+test_files:
+- spec/lib/bitly_quickly_spec.rb
+- spec/spec_helper.rb
+has_rdoc: