bitly-oauth 0.1.0

data/lib/bitly_oauth/country.rb

@@ -0,0 +1,10 @@
+module BitlyOAuth
+  class Country
+    attr_reader :clicks, :country
+
+    def initialize(options = {})
+      @clicks  = options['clicks']
+      @country = options['country']
+    end
+  end
+end

data/lib/bitly_oauth/day.rb

@@ -0,0 +1,12 @@
+module BitlyOAuth
+
+  # Day objects are created by the clicks_by_day method of a url
+  class Day
+    attr_reader :clicks, :day_start
+
+    def initialize(options = {})
+      @clicks    = options['clicks']
+      @day_start = Time.at(options['day_start']) if options['day_start']
+    end
+  end
+end

data/lib/bitly_oauth/error.rb

@@ -0,0 +1,15 @@
+module BitlyOAuth
+  class Error < StandardError
+    attr_reader :code, :response
+
+    alias :msg :message
+
+    def initialize(response)
+      @response = response
+      @message  = response.reason
+      @code     = response.status
+
+      super("#{@message} - '#{@code}'")
+    end
+  end
+end

data/lib/bitly_oauth/lib/core_ext/hash.rb

@@ -0,0 +1,27 @@
+class Hash
+  def to_query
+    map {|k, v|"#{k}=#{v}"}.sort * '&'
+  end
+
+  def stringify_keys!
+    keys.each do |key|
+      self[key.to_s] = delete(key)
+    end
+    self
+  end
+
+  def stringify_keys
+    dup.stringify_keys!
+  end
+
+  def symbolize_keys!
+    keys.each do |key|
+      self[(key.to_sym rescue key) || key] = delete(key)
+    end
+    self
+  end
+
+  def symbolize_keys
+    dup.symbolize_keys!
+  end
+end

data/lib/bitly_oauth/lib/core_ext/string.rb

@@ -0,0 +1,5 @@
+class String
+  def to_a
+    [ self ]
+  end
+end

data/lib/bitly_oauth/missing_url.rb

@@ -0,0 +1,12 @@
+module BitlyOAuth
+  class MissingUrl
+    attr_accessor :short_url, :user_hash, :long_url, :error
+
+    def initialize(options={})
+      @error     = options['error']
+      @long_url  = options['long_url']
+      @short_url = options['short_url']
+      @user_hash = options['hash']
+    end
+  end
+end

data/lib/bitly_oauth/realtime_link.rb

@@ -0,0 +1,16 @@
+module BitlyOAuth
+  # Day objects are created by the realtime_links method of a user
+  class RealtimeLink
+    attr_reader :clicks, :user_hash
+
+    def initialize(options = {})
+      @clicks    = options['clicks']
+      @user_hash = options['user_hash']
+    end
+
+    # A convenience method to create a BitlyOAuth::Url from the data
+    def create_url(client)
+      BitlyOAuth::Url.new(client, 'user_clicks' => clicks, 'user_hash' => user_hash)
+    end
+  end
+end

data/lib/bitly_oauth/referrer.rb

@@ -0,0 +1,12 @@
+module BitlyOAuth
+  class Referrer
+    attr_reader :clicks, :referrer, :referrer_app, :url
+
+    def initialize(options={})
+      @url          = options['url']
+      @clicks       = options['clicks']
+      @referrer     = options['referrer']
+      @referrer_app = options['referrer_app']
+    end
+  end
+end

data/lib/bitly_oauth/referring_domain.rb

@@ -0,0 +1,11 @@
+module BitlyOAuth
+  class ReferringDomain
+    attr_reader :clicks, :domain
+
+    def initialize(options={})
+      @clicks = options['clicks']
+      @domain = options['domain']
+    end
+  end
+end
+

data/lib/bitly_oauth/response.rb

@@ -0,0 +1,39 @@
+module BitlyOAuth
+  class Response
+    REASONS = { "OK"          => "OK",
+                "INVALID_URI" => "Invalid URI" }.freeze
+
+    def initialize(response)
+      @response = response
+    end
+
+    def success?
+      parsed['status_code'] == 200
+    end
+
+    def status
+      parsed['status_code']
+    end
+
+    def reason
+      status = parsed['status_txt']
+      REASONS[ status ] || status.split('_').map(&:capitalize) * ' '
+    end
+
+    def body
+      parsed['data']
+    end
+
+    private
+    def parsed
+      case @response
+      when OAuth2::Response
+        @response.parsed
+      when HTTParty::Response
+        @response.parsed_response
+      else
+        raise "Unsupported Response type: #{@response.class}"
+      end
+    end
+  end
+end

data/lib/bitly_oauth/url.rb

@@ -0,0 +1,118 @@
+module BitlyOAuth
+
+  class Url
+    attr_reader :short_url, :long_url, :user_hash, :global_hash, :referrers, :countries
+
+    # Initialize with a bitly client and optional hash to fill in the details for the url.
+    def initialize(client, options = {})
+      @client        = client
+      @title         = options['title'] || '' if options.key?('title')
+      @new_hash      = (options['new_hash'] == 1)
+      @long_url      = options['long_url']
+      @user_hash     = options['hash'] || options['user_hash']
+      @short_url     = options['url'] || options['short_url'] || "http://bit.ly/#{@user_hash}"
+      @created_by    = options['created_by']
+      @global_hash   = options['global_hash']
+      @user_clicks   = options['user_clicks']
+      @global_clicks = options['global_clicks']
+
+      @referrers = options['referrers'].map{|referrer| BitlyOAuth::Referrer.new(referrer) } if options['referrers']
+      @countries = options['countries'].map{|country| BitlyOAuth::Country.new(country) } if options['countries']
+
+      if options['clicks'] && options['clicks'][0].is_a?(Hash)
+        @clicks_by_day = options['clicks'].map{|day| BitlyOAuth::Day.new(day)}
+      else
+        @clicks_by_minute = options['clicks']
+      end
+    end
+
+    # Returns true if the user hash was created first for this call
+    def new_hash?
+      @new_hash
+    end
+
+    # If the url already has click statistics, returns the user clicks.
+    # IF there are no click statistics or <tt>:force => true</tt> is passed,
+    # updates the stats and returns the user clicks
+    def user_clicks(options={})
+      update_clicks_data if @user_clicks.nil? || options[:force]
+      @user_clicks
+    end
+
+    # If the url already has click statistics, returns the global clicks.
+    # IF there are no click statistics or <tt>:force => true</tt> is passed,
+    # updates the stats and returns the global clicks
+    def global_clicks(options={})
+      update_clicks_data if @global_clicks.nil? || options[:force]
+      @global_clicks
+    end
+
+    # If the url already has the title, return it.
+    # IF there is no title or <tt>:force => true</tt> is passed,
+    # updates the info and returns the title
+    def title(options={})
+      update_info if @title.nil? || options[:force]
+      @title
+    end
+
+    # If the url already has the creator, return it.
+    # IF there is no creator or <tt>:force => true</tt> is passed,
+    # updates the info and returns the creator
+    def created_by(options={})
+      update_info if @created_by.nil? || options[:force]
+      @created_by
+    end
+
+    # If the url already has referrer data, return it.
+    # IF there is no referrer or <tt>:force => true</tt> is passed,
+    # updates the referrers and returns them
+    def referrers(options={})
+      if @referrers.nil? || options[:force]
+        full_url = @client.referrers(@user_hash || @short_url)
+        @referrers = full_url.referrers
+      end
+      @referrers
+    end
+
+    # If the url already has country data, return it.
+    # IF there is no country or <tt>:force => true</tt> is passed,
+    # updates the countries and returns them
+    def countries(options={})
+      if @countries.nil? || options[:force]
+        full_url = @client.countries(@user_hash || @short_url)
+        @countries = full_url.countries
+      end
+      @countries
+    end
+
+    def clicks_by_minute(options={})
+      if @clicks_by_minute.nil? || options[:force]
+        full_url = @client.clicks_by_minute(@user_hash || @short_url)
+        @clicks_by_minute = full_url.clicks_by_minute
+      end
+      @clicks_by_minute
+    end
+
+    def clicks_by_day(options={})
+      if @clicks_by_day.nil? || options[:force]
+        full_url = @client.clicks_by_day(@user_hash || @short_url)
+        @clicks_by_day = full_url.clicks_by_day
+      end
+      @clicks_by_day
+    end
+
+    private
+
+    def update_clicks_data
+      full_url = @client.clicks(@user_hash || @short_url)
+      @global_clicks = full_url.global_clicks
+      @user_clicks = full_url.user_clicks
+    end
+
+    def update_info
+      full_url = @client.info(@user_hash || @short_url)
+      @created_by = full_url.created_by
+      @title = full_url.title
+    end
+  end
+end

data/lib/bitly_oauth/user.rb

@@ -0,0 +1,104 @@
+module BitlyOAuth
+
+  # A user requires a BitlyOAuth::AccessToken. The flow is as follows:
+  #
+  #     client = BitlyOAuth::Client.new(consumer_token, consumer_secret)
+  #     client.authorize_url(redirect_url)
+  #     #=> "https://bitly.com/oauth/authorize?client_id=id&type=code&redirect_uri=http%3A%2F%2Ftest.local%2Fbitly-oauth%2Fauth"
+  # Redirect your users to this url, when they authorize your application
+  # they will be redirected to the url you provided with a code parameter.
+  # Use that parameter, and the exact same redirect url as follows:
+  #
+  #     token = o.get_access_token_from_code(params[:code], redirect_url)
+  #     #=> #<BitlyOAuth::AccessToken ...>
+  #
+  # Then use that access token to create your user object.
+  #
+  #    user = BitlyOAuth::User.new(token)
+  class User
+
+    def initialize(access_token)
+      @access_token = access_token
+    end
+
+    # OAuth 2 endpoint that provides a list of top referrers (up to 500 per
+    # day) for a given user’s bit.ly links, and the number of clicks per referrer. 
+    #
+    # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/referrers
+    def referrers(options={})
+      if @referrers.nil? || options.delete(:force)
+        @referrers = get_method(:referrers, BitlyOAuth::Referrer, options)
+      end
+      @referrers
+    end
+
+    # OAuth 2 endpoint that provides a list of countries from which clicks
+    # on a given user’s bit.ly links are originating, and the number of clicks per country. 
+    #
+    # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/countries
+    def countries(options={})
+      if @countries.nil? || options.delete(:force)
+        @countries = get_method(:countries, BitlyOAuth::Country, options)
+      end
+      @countries
+    end
+
+    # OAuth 2 endpoint that provides a given user’s 100 most popular links
+    # based on click traffic in the past hour, and the number of clicks per link. 
+    #
+    # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/realtime_links
+    def realtime_links(options={})
+      if @realtime_links.nil? || options.delete(:force)
+        result = get(:realtime_links, options)
+        @realtime_links = result['realtime_links'].map { |rs| BitlyOAuth::RealtimeLink.new(rs) }
+      end
+      @realtime_links
+    end
+
+    # OAuth 2 endpoint that provides the total clicks per day on a user’s bit.ly links.
+    #
+    # http://code.google.com/p/bitly-api/wiki/ApiDocumentation#/v3/user/clicks
+    def clicks(options={})
+      get_clicks(options)
+      @clicks
+    end
+
+    # Displays the total clicks returned from the clicks method.
+    def total_clicks(options={})
+      get_clicks(options)
+      @total_clicks
+    end
+
+    # Returns a Bitly Client using the credentials of the user.
+    def client
+      @client ||= begin
+        client = BitlyOAuth::Client.new(@access_token.client.id, @access_token.client.secret)
+        client.set_access_token_from_token(@access_token.token)
+        client
+      end
+    end
+
+    private
+
+    def get_method(method, klass, options)
+      result = get(method, options)
+      result[method.to_s].map do |rs|
+        rs.map do |obj|
+          klass.new(obj)
+        end
+      end
+    end
+
+    def get_clicks(options={})
+      if @clicks.nil? || options.delete(:force)
+        result = get(:clicks, options)
+        @clicks = result['clicks'].map { |rs| BitlyOAuth::Day.new(rs) }
+        @total_clicks = result['total_clicks']
+      end
+    end
+
+    def get(method, options)
+      @access_token.get("user/#{method}", options)
+    end
+  end
+end

data/test/fixtures/9uX1TE.json

@@ -0,0 +1 @@
+{ "status_code": 200, "status_txt": "OK", "data": { "expand": [ { "hash": "9uX1TE", "long_url": "http:\/\/betaworks.com\/", "user_hash": "9uX1TE", "global_hash": "18H1ET" } ] } }

data/test/fixtures/9uX1TEclicks.json

@@ -0,0 +1 @@
+{"status_code": 200, "data": {"clicks": [{"user_clicks": 0, "global_hash": "18H1ET", "hash": "9uX1TE", "user_hash": "9uX1TE", "global_clicks": 81}]}, "status_txt": "OK"}

data/test/fixtures/9uX1TEclicks2.json

@@ -0,0 +1 @@
+{"status_code": 200, "data": {"clicks": [{"user_clicks": 1, "global_hash": "18H1ET", "hash": "9uX1TE", "user_hash": "9uX1TE", "global_clicks": 82}]}, "status_txt": "OK"}

data/test/fixtures/9uX1TEinfo.json

@@ -0,0 +1 @@
+{"status_code": 200, "data": {"info": [{"global_hash": "18H1ET", "hash": "9uX1TE", "user_hash": "9uX1TE", "created_by": "philnash", "title": "A title"}]}, "status_txt": "OK"}

data/test/fixtures/9uX1TEinfo2.json

@@ -0,0 +1 @@
+{"status_code": 200, "data": {"info": [{"global_hash": "18H1ET", "hash": "9uX1TE", "user_hash": "9uX1TE", "created_by": "philnash2", "title": "A New Title"}]}, "status_txt": "OK"}

data/test/fixtures/auth_fail.json

@@ -0,0 +1 @@
+{"data":{"authenticate":{"successful": false}},"status_code": 200,"status_txt": "OK"}

data/test/fixtures/auth_success.json

@@ -0,0 +1 @@
+{"data":{"authenticate":{"api_key": "R_0da49e0a9118ff35f52f629d2d71bf07","successful": true,"username": "bitlyapidemo"}},"status_code": 200,"status_txt": "OK"}

data/test/fixtures/betaworks.json

@@ -0,0 +1 @@
+{ "status_code": 200, "status_txt": "OK", "data": { "long_url": "http:\/\/betaworks.com\/", "url": "http:\/\/bit.ly\/9uX1TE", "hash": "9uX1TE", "global_hash": "18H1ET", "new_hash": 1 } }

data/test/fixtures/betaworks2.json

@@ -0,0 +1 @@
+{ "status_code": 200, "status_txt": "OK", "data": { "long_url": "http:\/\/betaworks.com\/", "url": "http:\/\/bit.ly\/9uX1TE", "hash": "9uX1TE", "global_hash": "18H1ET", "new_hash": 0 } }

data/test/fixtures/betaworks_jmp.json

@@ -0,0 +1 @@
+{ "status_code": 200, "status_txt": "OK", "data": { "long_url": "http:\/\/betaworks.com\/", "url": "http:\/\/j.mp\/9uX1TE", "hash": "9uX1TE", "global_hash": "18H1ET", "new_hash": 0 } }

data/test/fixtures/betaworks_other_user.json

@@ -0,0 +1 @@
+{ "status_code": 200, "status_txt": "OK", "data": { "long_url": "http:\/\/betaworks.com\/", "url": "http:\/\/bit.ly\/cWJlxM", "hash": "cWJlxM", "global_hash": "18H1ET", "new_hash": 1 } }

data/test/fixtures/bitly9uX1TE.json

@@ -0,0 +1 @@
+{ "status_code": 200, "status_txt": "OK", "data": { "expand": [ { "short_url": "http:\/\/bit.ly\/9uX1TE", "long_url": "http:\/\/betaworks.com\/", "user_hash": "9uX1TE", "global_hash": "18H1ET" } ] } }

data/test/fixtures/bitly_pro_domain.json

@@ -0,0 +1 @@
+{"status_code": 200, "data": {"domain": "nyti.ms", "bitly_pro_domain": true}, "status_txt": "OK"}