bitly-oauth 0.1.0

data/History.txt

@@ -0,0 +1,154 @@
+=== 0.1.0 / 2012-1-21
+* Rename Project to BitlyOAuth
+
+  * Remove Login and ApiKey Authentication
+  * Remove strategies
+  * Rollback version to 0.1.0
+  * Add Referring Domains Endpoint
+
+=== 0.8.0 / 2012-1-17
+
+* Major Refactor
+
+  * Adds Authentication Strategies
+  * Client supports OAuth & Login/ApiKey strategies
+  * User supports AccessToken strategy
+  * Forked original project. Pull requests in original project showed no movement.
+
+=== 0.7.0 / 2011-1-8
+
+* 1 major bug fix
+
+  * Updates OAuth2 gem and fixes OAuth class
+
+* 1 minor enhancement
+
+  Adds link_history to user model
+
+=== 0.6.2 / 2011-11-10
+
+* 2 minor enhancements
+
+  * Adds days parameter to clicks_by_minute v3 API call
+  * Converts Readme to markdown
+
+* 2 minor bug fixes
+
+  * Increases HTTParty version to avoid issues with Rubygems
+  * Stops mutating arguments on array methods
+
+=== 0.6.1 / 2011-01-12
+
+* 1 minor enhancement
+
+  * Updated OAuth2 gem and used extra information to save login and api_key to user objects
+
+=== 0.6.0 / 2011-01-03
+
+* 1 major enhancement
+
+  * Added OAuth 2 and User calls for the version 3 API
+
+=== 0.5.5 / 2010-12-22
+
+* 1 minor bug fix
+
+  * fixed method redifined warnings
+
+=== 0.5.4 / 2010-12-01
+
+* 4 minor enhancements
+
+  * Added referrers, countries, clicks_by_minute and clicks_by_day calls to the version 3 API
+
+=== 0.5.3 / 2010-07-30
+
+* 1 minor enhancement
+
+  * Added the info call to the version 3 API
+
+=== 0.5.2 / 2010-07-18
+
+* 1 minor enhancement
+
+  * Added the lookup call to the version 3 API.
+
+=== 0.5.1 / 2010-05-26
+
+* 1 bug fix
+
+  * When expanding a short url with the v3 module, user hash and short url weren't being set properly
+
+=== 0.5.0 / 2010-05-12
+
+* Loads of major enhancements
+
+  * Support for version 3 of the bit.ly API
+  * deprecation for version 2 client object
+
+=== 0.4.0 / 2009-12-19
+
+* 1 major enhancement
+
+  * support for j.mp urls
+
+=== 0.3.2 / 2009-11-15
+
+* 1 bug fix
+
+  * called the wrong variable in case of error in the creation of a Url object
+
+=== 0.3.1 / 2009-07-29
+
+* 1 minor enhancement
+
+  * removed require 'rubygems' from library (http://gist.github.com/54177)
+
+=== 0.3 / 2009-07-09
+
+* 1 major enhancement
+
+  * a full set of tests, properly mocked
+
+* 1 minor enhancement
+
+  * calling bitly.shorten(:history => 1) will add the url to the api user's history.
+
+* 1 bug fix
+
+  * you can no longer call shorten with a keyword, this was unsupported in the API and consequently removed
+
+=== 0.2 / 2009-06-23
+
+* 1 enhancement
+
+  * Depends on Crack instead of JSON, so can run on Jruby
+
+* 1 bug fix
+
+  * Does not choke when bit.ly chokes. Returns a BitlyError instead
+
+=== 0.1.4 / 2009-04-13
+
+* 1 bug fix
+
+  * Urls with parameters were choking, changed to using CGI.
+
+=== 0.1.2 / 2009-03-12
+
+* 1 minor enhancement
+
+  * Allows to add a keyword for shortening urls
+
+=== 0.1.1 / 2009-01-26
+
+* 1 bug fix
+
+  * Didn't include dependency on JSON
+
+=== 0.1.0 / 2009-01-26
+
+* 1 major enhancement
+
+  * First release
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2012 jonstorer
+
+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,87 @@
+# bitly-oauth
+
+## DESCRIPTION:
+
+A Ruby API for [http://bit.ly](http://bit.ly)
+
+[http://code.google.com/p/bitly-api/wiki/ApiDocumentation](http://code.google.com/p/bitly-api/wiki/ApiDocumentation)
+
+## NOTE:
+
+BitlyOAuth supports version 3 of the API as well as OAuth authenticate for user access.
+
+To use, you will need a client id and client secret. Get yours at [http://bitly.com/a/account](http://bitly.com/a/account).
+
+    client = BitlyOAuth::Client.new(client_id, client_secret)
+
+With a ``BitlyOAuth::Client`` you have access to the following API endpoints:
+``shorten``, ``expand``, ``lookup``, ``info``, ``clicks``, ``clicks_by_minute``,
+``clicks_by_day``, ``countries``, ``referrers``, ``referring_domains``,
+``validate``, ``bitly_pro_domain``  See [http://bit.ly/apidocs](http://bit.ly/apidocs) for details.
+
+## INSTALLATION:
+
+    gem install bitly-oauth
+
+## USAGE:
+
+Please see the Bit.ly API documentation [http://bit.ly/apidocs](http://bit.ly/apidocs) for details on the V3 API.
+
+You can initialize a client through the following shortcut as well:
+
+    client = BitlyOAuth.new("client id", "client secret")
+    client.set_access_token_from_token('token')
+
+You can then use that client to shorten or expand urls or return more information or statistics as so:
+
+    client.shorten('http://www.google.com')
+    client.shorten('http://www.google.com', :history => 1) # adds the url to the api user's history
+
+    client.expand('wQaT') || client.expand('http://bit.ly/wQaT')
+    client.info('wQaT')   || client.info('http://bit.ly/wQaT')
+    client.stats('wQaT')  || client.stats('http://bit.ly/wQaT')
+
+Each can be used in all the methods described in the API docs, the shorten function, for example, takes a url or an array of urls.
+
+Then functions ``shorten``, ``expand``, ``info``, and ``stats`` return a ``BitlyOAuth::Url`` object (or an array of ``BitlyOAuth::Url`` objects if you supplied an array as the input). You can then get all the information required from that object.
+
+    url = client.shorten('http://www.google.com') #=> BitlyOAuth::Url
+
+    url.clicks_by_day    #=> an array of ``BitlyOAuth::Day``s
+    url.countries        #=> an array of ``BitlyOAuth::Country``s
+    url.referrers        #=> an array of ``BitlyOAuth::Referrer``s
+    url.clicks_by_minute #=> an array of 60 integers representing click counts over the last 60 minutes
+    url.created_by       #=> string  / http://bit.ly/apidocs#/v3/info
+    url.global_clicks    #=> integer / http://bit.ly/apidocs#/v3/clicks
+    url.global_hash      #=> string  / http://bit.ly/apidocs#/v3/info
+    url.long_url         #=> string  / http://bit.ly/apidocs#/v3/expand
+    url.new_hash?        #=> boolean / http://bit.ly/apidocs#/v3/shorten
+    url.short_url        #=> string  / http://bit.ly/apidocs#/v3/shorten
+    url.title            #=> string  / http://bit.ly/apidocs#/v3/info
+    url.user_clicks      #=> integer / http://bit.ly/apidocs#/v3/clicks
+    url.user_hash        #=> string  / http://bit.ly/apidocs#/v3/expand
+
+## LICENSE:
+
+> (The MIT License)
+>
+> Copyright (c) 2012 Jonathon Storer
+>
+> 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.rdoc

@@ -0,0 +1,35 @@
+= bitly
+
+== DESCRIPTION:
+
+A Ruby API for version 3 of the http://bit.ly API, including j.mp and bitly.Pro support.
+
+http://api.bit.ly
+
+== INSTALLATION:
+
+<tt>gem install bitly-oauth</tt>
+
+== USAGE:
+
+Create a client using your client id and client secret from http://bit.ly
+
+<tt>client = BitlyOAuth.new(client_id, client_secret)</tt>
+
+Then use that client to shorten or expand urls and hashes.
+
+<tt>client.shorten('http://google.com')</tt>
+
+== Note on Patches/Pull Requests
+
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 jonstorer. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,42 @@
+require 'rubygems'
+require 'rake'
+require 'jeweler'
+
+Jeweler::Tasks.new do |gem|
+  gem.name = "bitly-oauth"
+  gem.summary = "A ruby wrapper for the bit.ly API"
+  gem.description = <<-DESCRIPTION
+A ruby wrapper for version 3 of the bit.ly API
+Supports OAuth authentication
+DESCRIPTION
+  gem.email = "jonathon.scott.storer@gmail.com"
+  gem.homepage = "http://github.com/jonstorer/bitly-oauth"
+  gem.authors = ["jonstorer"]
+  gem.add_dependency 'httparty', ">= 0.7.6"
+  gem.add_dependency 'oauth2', '>= 0.1.1'
+  gem.add_development_dependency "shoulda", ">= 0"
+  gem.add_development_dependency "jeweler", ">= 1.4.0"
+  gem.add_development_dependency "rcov", ">= 0"
+  gem.add_development_dependency "mocha", ">= 0.10.0"
+  gem.add_development_dependency "fakeweb", ">= 1.2.8"
+  # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "bitly-oauth #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/lib/bitly_oauth.rb

@@ -0,0 +1,28 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'httparty'
+require 'oauth2'
+require 'cgi'
+require 'forwardable'
+
+module BitlyOAuth
+  def self.new(*args)
+    BitlyOAuth::Client.new(*args)
+  end
+end
+
+require 'bitly_oauth/access_token'
+require 'bitly_oauth/client'
+require 'bitly_oauth/country'
+require 'bitly_oauth/day'
+require 'bitly_oauth/error'
+require 'bitly_oauth/missing_url'
+require 'bitly_oauth/realtime_link'
+require 'bitly_oauth/referring_domain'
+require 'bitly_oauth/referrer'
+require 'bitly_oauth/response'
+require 'bitly_oauth/url'
+require 'bitly_oauth/user'
+
+require 'bitly_oauth/lib/core_ext/hash'
+require 'bitly_oauth/lib/core_ext/string'

data/lib/bitly_oauth/access_token.rb

@@ -0,0 +1,37 @@
+module BitlyOAuth
+  class AccessToken
+    extend Forwardable
+    delegate [ :client, :token ] => :access_token
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    def get(method, options)
+      request(:get, method, options)
+    end
+
+    def post(method, options)
+      request(:post, method, options)
+    end
+
+    private
+    def request(verb, method, options={})
+      response = access_token.send(verb, method, :params => params(options), :parse => :json)
+      response = BitlyOAuth::Response.new(response)
+      if response.success?
+        response.body
+      else
+        raise BitlyOAuth::Error.new(response)
+      end
+    end
+
+    def params(options={})
+      { :access_token => access_token.token }.merge(options)
+    end
+
+    def access_token
+      @access_token
+    end
+  end
+end

data/lib/bitly_oauth/client.rb

@@ -0,0 +1,149 @@
+module BitlyOAuth
+  class Client
+    extend Forwardable
+    delegate [ :get, :post ] => :access_token
+
+    BASE_URL = 'https://api-ssl.bit.ly/v3/'
+
+    def initialize(client_id, client_secret)
+      @client_id     = client_id
+      @client_secret = client_secret
+    end
+
+    def authorize_url(redirect_url)
+      client.auth_code.authorize_url(:redirect_uri => redirect_url).gsub(/api-ssl.bit.ly/,'bitly.com')
+    end
+
+    def get_access_token_from_code(code, redirect_url)
+      access_token = client.auth_code.get_token(code, :redirect_uri => redirect_url, :parse => :query)
+      BitlyOAuth::AccessToken.new(access_token)
+    end
+
+    def set_access_token_from_code(*args)
+      @access_token ||= get_access_token_from_code(*args)
+    end
+
+    def get_access_token_from_token(token, params={})
+      params.stringify_keys!
+      access_token = ::OAuth2::AccessToken.new(client, token, params)
+      BitlyOAuth::AccessToken.new(access_token)
+    end
+
+    def set_access_token_from_token(*args)
+      @access_token ||= get_access_token_from_token(*args)
+    end
+
+    def bitly_pro_domain(domain)
+      get(:bitly_pro_domain, :domain => domain)['bitly_pro_domain']
+    end
+    alias :pro? :bitly_pro_domain
+
+    # Validates a login and api key
+    def validate(x_login, x_api_key)
+      get(:validate, :x_login => x_login, :x_apiKey => x_api_key)['valid'] == 1
+    end
+    alias :valid? :validate
+
+    def shorten(long_url, options={})
+      response = get(:shorten, { :longUrl => long_url }.merge(options))
+      BitlyOAuth::Url.new(self, response)
+    end
+
+    def expand(input)
+      get_method(:expand, input)
+    end
+
+    def clicks(input)
+      get_method(:clicks, input)
+    end
+
+    def info(input)
+      get_method(:info, input)
+    end
+
+    def clicks_by_minute(input)
+      get_method(:clicks_by_minute, input)
+    end
+
+    def clicks_by_day(input, options={})
+      options.reject! { |k, v| k.to_s != 'days' }
+      get_method(:clicks_by_day, input, options)
+    end
+
+    def countries(input)
+      get_single_method(:countries, input)
+    end
+
+    def referrers(input)
+      get_single_method(:referrers, input)
+    end
+
+    def referring_domains(link, options={})
+      response = get('link/referring_domains', :link => link)
+      response['referring_domains'].map do |referring_domain|
+        BitlyOAuth::ReferringDomain.new(referring_domain)
+      end
+    end
+
+    def lookup(input)
+      input = input.to_a
+      response = get(:lookup, :url => input)
+      results = response['lookup'].inject([]) do |results, url|
+        index = input.index(url['long_url'] = url.delete('url'))
+        if url['error'].nil?
+          results[index] = BitlyOAuth::Url.new(self, url)
+        else
+          results[index] = BitlyOAuth::MissingUrl.new(url)
+        end
+        input[index] = nil
+        results
+      end
+      results.length > 1 ? results : results[0]
+    end
+
+    private
+
+    def get_method(method, input, options={})
+      options.symbolize_keys!
+      input = input.to_a
+
+      input.each do |i|
+        (options[key_for(i)] ||= []) << i
+      end
+
+      response = get(method, options)
+
+      results = response[method.to_s].inject([]) do |results, url|
+        result_index = input.index(url['short_url'] || url['hash']) || input.index(url['global_hash'])
+
+        if url['error'].nil?
+          results[result_index] = BitlyOAuth::Url.new(self, url)
+        else
+          results[result_index] = BitlyOAuth::MissingUrl.new(url)
+        end
+        input[result_index] = nil
+        results
+      end
+      results.length > 1 ? results : results[0]
+    end
+
+    def get_single_method(method, input)
+      raise ArgumentError.new("This method only takes a hash or url input") unless input.is_a? String
+
+      response = get(method, key_for(input) => input.to_a)
+      BitlyOAuth::Url.new(self, response)
+    end
+
+    def client
+      @client ||= ::OAuth2::Client.new(@client_id, @client_secret, :site => BASE_URL, :token_url => '/oauth/access_token')
+    end
+
+    def access_token
+      @access_token
+    end
+
+    def key_for(input)
+      input.match(/^http:\/\//) ? :shortUrl : :hash
+    end
+  end
+end