multi_bitly 0.1.0

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 @@
+--color

data/.ruby-gemset

@@ -0,0 +1 @@
+multi_bitly

data/.ruby-version

@@ -0,0 +1 @@
+ruby-1.9.3

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Sharethrough, Inc. http://www.sharethrough.com/
+
+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,74 @@
+# MultiBitly
+
+Allows access to the bit.ly API with multiple accounts.
+
+MultiBitly is a wrapper around the [Bitly](https://github.com/philnash/bitly) gem that makes it easy to generate multiple shortened Bitly links for a given URL.
+
+When shortening a URL, Bitly will return the same hash regardless of how many times you request a new one. One way around this is to use a different Bitly account to shorten the same URL, resulting in a different hash.
+
+Such a pain. Until now.
+
+Now, with a list of Bitly accounts, MultiBitly will automatically shorten URLs for each account, resulting in a list of shortened Bitly links for one URL.
+
+### So what?
+
+If you've ever wanted to use Bitly links as distribution channels to track a URL, you're going to be a [whole](http://cutestuff.co/wp-content/uploads/2011/09/tumblr_lr6ed9uQSi1qzfvwyo1_500.jpg) [lot](http://www.stevecurtin.com/blog/wp-content/uploads/2011/10/Cute-puppy.jpg) [happier](http://onwardstate.com/wp-content/uploads/2013/04/puppy1.jpg). Just keep track of which account has already shortened the URL, and we'll take care of the rest.
+
+## Installation
+
+Add this to your Gemfile
+
+    gem install multi_bitly
+
+MultiBitly currently requires an ActiveRecord class that keeps track of the usernames and URLs already shortened through Bitly. The default name is `BitlyAccount`, but you can override it in the config.
+
+You will also need to create an initializer to set the account information. You can find a Bitly account's API key [here](https://bitly.com/a/your_api_key).
+
+## Show me the code
+
+    # config/initializers/multi_bitly.rb
+    MultiBitly::configure do |config|
+      config.accounts = [
+        { username: 'user1', api_key: 'key1' },
+        { username: 'user1', api_key: 'key2' }
+      ]
+    end
+
+    # app/models/bitly_account.rb
+    class BitlyAccount < ActiveRecord::Base
+      attr_accessible :username, :url
+
+      validates :username, :url, presence: true
+      validates :username, uniqueness: { scope: :url } # one URL per user
+    end
+
+    # a sample class to shorten a URL and mark the account that shortened it
+    class ShortenAllTheThings
+
+    def initialize(url)
+      @url = url
+    end
+
+    def shorten
+      client = MultiBitly::Client.new
+      response = client.shorten(@url)
+      BitlyAccount.create!(username: response.account.username, url: 'http://google.com')
+      response.short_url
+    end
+
+    ShortenAllTheThings.new('http://google.com').shorten # => http://bit.ly/900913
+    ShortenAllTheThings.new('http://google.com').shorten # => http://bit.ly/11JpHp5
+    # now we're all out of acounts so we'll use the last one
+    ShortenAllTheThings.new('http://google.com').shorten # => http://bit.ly/11JpHp5
+
+## Contributors
+* [Danny Olson](https://github.com/dbolson)
+
+## Contributions welcome
+Any contributions are welcome. Simply follow the steps below to get started:
+
+1. Fork it
+2. Create your feature branch (git checkout -b my-new-feature)
+3. Commit your changes (git commit -am 'Added some feature')
+4. Push to the branch (git push origin my-new-feature)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+begin
+  require 'rspec/core/rake_task'
+  RSpec::Core::RakeTask.new(:spec)
+
+  task test: :spec
+  task default: :spec
+rescue LoadError => e
+  desc 'Run specs'
+  task :default do
+    abort 'rake task is not available.'
+  end
+end

data/lib/multi_bitly/account.rb

@@ -0,0 +1,23 @@
+module MultiBitly
+  class Account
+    def initialize(url)
+      @url = url
+    end
+
+    def username
+      finder.new(url).account[:username]
+    end
+
+    def api_key
+      finder.new(url).account[:api_key]
+    end
+
+    private
+
+    attr_reader :url
+
+    def finder
+      AccountFinder
+    end
+  end
+end

data/lib/multi_bitly/account_finder.rb

@@ -0,0 +1,33 @@
+module MultiBitly
+  class AccountFinder
+    def initialize(url)
+      @url = url
+      @accounts = MultiBitly.configuration.accounts
+      @data_store = MultiBitly.configuration.data_store
+    end
+
+    def account
+      last_account = nil
+
+      accounts.each do |account|
+        found_account = existing_account(account)
+        if found_account.empty?
+          return account
+        else
+          last_account = account
+        end
+      end
+      last_account
+    end
+
+    private
+
+    attr_reader :url,
+                :accounts,
+                :data_store
+
+    def existing_account(account)
+      data_store.where(username: account[:username], url: url)
+    end
+  end
+end

data/lib/multi_bitly/client.rb

@@ -0,0 +1,33 @@
+module MultiBitly
+  class Client
+    class Error < StandardError; end
+
+    def initialize(api_client=Bitly)
+      @api_client = api_client
+    end
+
+    def shorten(url)
+      account = account(url)
+      api_response = client(account).shorten(url)
+      response(account, api_response)
+    end
+
+    private
+
+    attr_reader :api_client
+
+    def account(url)
+      Account.new(url)
+    end
+
+    def response(account, api_response)
+      Response.new(account, api_response)
+    end
+
+    def client(account)
+      @_client ||= api_client.new(account.username, account.api_key)
+    rescue => exception
+      raise Error.new("#{exception.class.to_s}: '#{exception.message}'")
+    end
+  end
+end

data/lib/multi_bitly/configuration.rb

@@ -0,0 +1,23 @@
+module MultiBitly
+  class Configuration
+    attr_accessor :accounts,
+                  :data_store
+
+    def initialize
+      @accounts = []
+    end
+
+    def data_store
+      @data_store ||= ::BitlyAccount
+    end
+  end
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Configuration.new
+    yield configuration
+  end
+end

data/lib/multi_bitly/response.rb

@@ -0,0 +1,12 @@
+require 'delegate'
+
+module MultiBitly
+  class Response < SimpleDelegator
+    attr_reader :account
+
+    def initialize(account, response)
+      @account = account
+      super(response)
+    end
+  end
+end

data/lib/multi_bitly/version.rb

@@ -0,0 +1,3 @@
+module MultiBitly
+  VERSION = '0.1.0'
+end

data/lib/multi_bitly.rb

@@ -0,0 +1,9 @@
+require 'multi_bitly/version'
+require 'multi_bitly/account'
+require 'multi_bitly/account_finder'
+require 'multi_bitly/client'
+require 'multi_bitly/configuration'
+require 'multi_bitly/response'
+
+module MultiBitly
+end

data/multi_bitly.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'multi_bitly/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'multi_bitly'
+  spec.version       = MultiBitly::VERSION
+  spec.authors       = ['Danny Olson']
+  spec.email         = ['dolson@sharethrough.com']
+  spec.description   = %q{Allows access to the bit.ly API with multiple accounts.}
+  spec.summary       = %q{Allows access to the bit.ly API with multiple accounts.}
+  spec.homepage      = 'https://github.com/sharethrough/multi_bitly'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files`.split($/)
+  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_dependency 'bitly'
+  spec.add_dependency 'json', '>= 1.7.7'
+  spec.add_development_dependency 'bundler', '~> 1.3'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 2.13'
+end

data/spec/multi_bitly/account_finder_spec.rb

@@ -0,0 +1,40 @@
+require 'spec_helper'
+
+describe MultiBitly::AccountFinder do
+  let(:account_finder) { MultiBitly::AccountFinder }
+  let(:data_store) { BitlyAccount }
+  let(:account1) {{ username: 'user1', api_key: 'key1' }}
+  let(:account2) {{ username: 'user2', api_key: 'key2' }}
+
+  before do
+    set_configuration
+  end
+
+  describe '#account' do
+    context 'with an unused account' do
+      it 'gets the attributes for the account' do
+        data_store.stub(:where).with(username: 'user1', url: 'example.com').and_return([])
+        found_account = account_finder.new('example.com').account
+        expect(found_account).to eq(account1)
+      end
+    end
+
+    context 'with a used account' do
+      it 'gets the attributes for the next available account' do
+        data_store.stub(:where).with(username: 'user1', url: 'example.com').and_return([data_store])
+        data_store.stub(:where).with(username: 'user2', url: 'example.com').and_return([])
+        found_account = account_finder.new('example.com').account
+        expect(found_account).to eq(account2)
+      end
+    end
+
+    context 'without any available accounts' do
+      it 'finds the last used account' do
+        data_store.stub(:where).with(username: 'user1', url: 'example.com').and_return([data_store])
+        data_store.stub(:where).with(username: 'user2', url: 'example.com').and_return([data_store])
+        found_account = account_finder.new('example.com').account
+        expect(found_account).to eq(account2)
+      end
+    end
+  end
+end

data/spec/multi_bitly/account_spec.rb

@@ -0,0 +1,23 @@
+require 'spec_helper'
+
+describe MultiBitly::Account do
+  let(:account) { MultiBitly::Account }
+
+  before do
+    set_configuration
+  end
+
+  describe '#username' do
+    it 'gets the username from the found account' do
+      found_account = account.new('example.com')
+      expect(found_account.username).to eq('user1')
+    end
+  end
+
+  describe '#api_key' do
+    it 'gets the api key from the found account' do
+      found_account = account.new('example.com')
+      expect(found_account.api_key).to eq('key1')
+    end
+  end
+end

data/spec/multi_bitly/client_spec.rb

@@ -0,0 +1,32 @@
+require 'spec_helper'
+
+describe MultiBitly::Client do
+  let(:client) { MultiBitly::Client }
+  let(:api_client) { ApiClient }
+
+  before do
+    set_configuration
+  end
+
+  context '#shorten' do
+    it 'delegates to the underlying client with an account' do
+      instance = client.new(api_client)
+      expect(instance.shorten('http://google.com').user_hash).to eq('g123')
+    end
+
+    context 'when the underlying client raises an exception' do
+      let(:account) { stub(:account, username: nil, api_key: nil) }
+
+      before do
+        api_client.stub(:new).and_raise(StandardError, 'api error')
+      end
+
+      it 'rescues and reraises the exception' do
+        instance = client.new(api_client)
+        expect {
+          instance.shorten('http://google.com')
+        }.to raise_error(MultiBitly::Client::Error, "StandardError: 'api error'")
+      end
+    end
+  end
+end

data/spec/multi_bitly/configuration_spec.rb

@@ -0,0 +1,69 @@
+require 'spec_helper'
+
+describe MultiBitly::Configuration do
+  describe '#accounts' do
+    context 'when set' do
+      before do
+        MultiBitly::configure do |config|
+          config.accounts = [
+            { username: 'user1', api_key: 'key1' },
+            { username: 'user2', api_key: 'key2' }
+          ]
+        end
+      end
+
+      after do
+        MultiBitly.configuration = nil
+      end
+
+      it 'uses the supplied accounts' do
+        expect(MultiBitly.configuration.accounts).to eq([
+          { username: 'user1', api_key: 'key1' },
+          { username: 'user2', api_key: 'key2' }
+        ])
+      end
+    end
+
+    context 'when not set' do
+      before do
+        MultiBitly::configure do |config|
+        end
+      end
+
+      it 'is an empty list' do
+        expect(MultiBitly.configuration.accounts).to eq([])
+      end
+    end
+  end
+
+  describe '#data_store' do
+    context 'when set' do
+      let(:data_store) { stub(:data_store) }
+
+      before do
+        MultiBitly::configure do |config|
+          config.data_store = data_store
+        end
+      end
+
+      after do
+        MultiBitly.configuration = nil
+      end
+
+      it 'uses the supplied data store' do
+        expect(MultiBitly.configuration.data_store).to eq(data_store)
+      end
+    end
+
+    context 'when not set' do
+      before do
+        MultiBitly::configure do |config|
+        end
+      end
+
+      it 'sets a default' do
+        expect(MultiBitly.configuration.data_store).to eq(BitlyAccount)
+      end
+    end
+  end
+end

data/spec/multi_bitly/response_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe MultiBitly::Response do
+  let(:responder) { MultiBitly::Response }
+
+  it 'delegates to the underlying response' do
+    account = stub(:account)
+    response = stub(:response, a_method: 'underlying method')
+    expect(responder.new(account, response).a_method).to eq('underlying method')
+  end
+
+  it 'sets the account' do
+    account = stub(:account)
+    expect(responder.new(account, stub).account).to eq(account)
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,32 @@
+require 'bitly'
+require 'multi_bitly'
+
+Bitly.use_api_version_3
+
+class BitlyAccount
+  def self.where(*args)
+    []
+  end
+end
+
+class ApiClient
+  def initialize(username, api_key)
+  end
+
+  def shorten(url)
+    Struct.new('ApiClient') do
+      def long_url; 'http://www.google.com'; end
+      def short_url; 'http://bit.ly/g123'; end
+      def user_hash; 'g123'; end
+    end.new
+  end
+end
+
+def set_configuration
+  MultiBitly::configure do |config|
+    config.accounts = [
+      { username: 'user1', api_key: 'key1' },
+      { username: 'user2', api_key: 'key2' }
+    ]
+  end
+end

metadata

@@ -0,0 +1,160 @@
+--- !ruby/object:Gem::Specification
+name: multi_bitly
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Danny Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-05-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bitly
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.7
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.13'
+description: Allows access to the bit.ly API with multiple accounts.
+email:
+- dolson@sharethrough.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .ruby-gemset
+- .ruby-version
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/multi_bitly.rb
+- lib/multi_bitly/account.rb
+- lib/multi_bitly/account_finder.rb
+- lib/multi_bitly/client.rb
+- lib/multi_bitly/configuration.rb
+- lib/multi_bitly/response.rb
+- lib/multi_bitly/version.rb
+- multi_bitly.gemspec
+- spec/multi_bitly/account_finder_spec.rb
+- spec/multi_bitly/account_spec.rb
+- spec/multi_bitly/client_spec.rb
+- spec/multi_bitly/configuration_spec.rb
+- spec/multi_bitly/response_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/sharethrough/multi_bitly
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2121263376112597564
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: -2121263376112597564
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.25
+signing_key: 
+specification_version: 3
+summary: Allows access to the bit.ly API with multiple accounts.
+test_files:
+- spec/multi_bitly/account_finder_spec.rb
+- spec/multi_bitly/account_spec.rb
+- spec/multi_bitly/client_spec.rb
+- spec/multi_bitly/configuration_spec.rb
+- spec/multi_bitly/response_spec.rb
+- spec/spec_helper.rb