bitly 1.1.1 → 2.0.1

data/lib/bitly/v3/country.rb

@@ -1,13 +0,0 @@
-module Bitly
-  module V3
-    class Country
-      attr_reader :clicks, :country
-    
-      def initialize(opts)
-        ['clicks', 'country'].each do |attribute|
-          instance_variable_set("@#{attribute}".to_sym, opts[attribute])
-        end
-      end
-    end
-  end
-end

data/lib/bitly/v3/day.rb

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

data/lib/bitly/v3/missing_url.rb

@@ -1,15 +0,0 @@
-module Bitly
-  module V3
-    class MissingUrl
-      attr_accessor :short_url, :user_hash, :long_url, :error
-      def initialize(opts={})
-        if opts
-          @short_url = opts['short_url']
-          @user_hash = opts['hash']
-          @long_url = opts['long_url']
-          @error = opts['error']
-        end
-      end
-    end
-  end
-end

data/lib/bitly/v3/oauth.rb

@@ -1,41 +0,0 @@
-module Bitly
-  module V3
-    # OAuth consumer for authentication
-    class OAuth
-      attr_reader :access_token
-      def initialize(consumer_token, consumer_secret)
-        @consumer_token, @consumer_secret = consumer_token, consumer_secret
-      end
-
-      # Get the OAuth 2 client
-      def client
-        @client ||= ::OAuth2::Client.new(
-          @consumer_token,
-          @consumer_secret,
-          :site => 'https://api-ssl.bitly.com',
-          :token_url => '/oauth/access_token'
-        )
-      end
-
-      # Get the url to redirect a user to, pass the url you want the user
-      # to be redirected back to.
-      def authorize_url(redirect_url, state=nil)
-        params = {:redirect_uri => redirect_url}
-        params[:state] = state if state
-        client.auth_code.authorize_url(params).gsub(/api-ssl\./,'')
-      end
-
-      # Get the access token. You must pass the exact same redirect_url passed
-      # to the authorize_url method
-      def get_access_token_from_code(code,redirect_url)
-        @access_token ||= client.auth_code.get_token(code, :redirect_uri => redirect_url, :parse => :query)
-      end
-
-      # If you already have a user token, this method gets the access token
-      def get_access_token_from_token(token, params={})
-        params = params.inject({}) { |options, (key, value)| options[key.to_s] = value; options }
-        @access_token ||= ::OAuth2::AccessToken.new(client, token, params)
-      end
-    end
-  end
-end

data/lib/bitly/v3/realtime_link.rb

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

data/lib/bitly/v3/referrer.rb

@@ -1,13 +0,0 @@
-module Bitly
-  module V3
-    class Referrer
-      attr_reader :clicks, :referrer, :referrer_app, :url
-    
-      def initialize(opts)
-        ['clicks', 'referrer', 'referrer_app', 'url'].each do |attribute|
-          instance_variable_set("@#{attribute}".to_sym, opts[attribute])
-        end
-      end
-    end
-  end
-end

data/lib/bitly/v3/url.rb

@@ -1,154 +0,0 @@
-module Bitly
-  module V3
-    # Url objects should only be created by the client object as it collects the correct information
-    # from the API.
-    class Url
-      attr_reader :short_url, :long_url, :user_hash, :global_hash, :aggregate_link
-
-      # Initialize with a bitly client and optional hash to fill in the details for the url.
-      def initialize(client, opts={})
-        @client = client
-        if opts
-          @short_url = opts['url'] || opts['short_url']
-          @long_url = opts['long_url']
-          @user_hash = opts['hash'] || opts['user_hash']
-          @global_hash = opts['global_hash']
-          @new_hash = (opts['new_hash'] == 1)
-          @user_clicks = opts['user_clicks']
-          @global_clicks = opts['global_clicks']
-          @title = opts['title']
-          @created_by = opts['created_by']
-          @created_at = Time.at opts['created_at'] if opts['created_at']
-          @aggregate_link = opts['aggregate_link']
-          @referrers = opts['referrers'].inject([]) do |results, referrer|
-            results << Bitly::V3::Referrer.new(referrer)
-          end if opts['referrers']
-          @countries = opts['countries'].inject([]) do |results, country|
-            results << Bitly::V3::Country.new(country)
-          end if opts['countries']
-          if opts['clicks'] && opts['clicks'][0].is_a?(Hash)
-            @clicks_by_day = opts['clicks'].inject([]) do |results, day|
-              results << Bitly::V3::Day.new(day)
-            end
-          else
-            @clicks_by_minute = opts['clicks']
-          end
-        end
-        @short_url = "http://bit.ly/#{@user_hash}" unless @short_url
-      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(opts={})
-        update_clicks_data if @global_clicks.nil? || opts[: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(opts={})
-        update_clicks_data if @global_clicks.nil? || opts[: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(opts={})
-        update_info if @title.nil? || opts[: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(opts={})
-        update_info if @created_by.nil? || opts[: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(opts={})
-        update_referrers if @referrers.nil? || opts[:force]
-        @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(opts={})
-        update_countries if @countries.nil? || opts[:force]
-        @countries
-      end
-
-      # If the url already has created at data, return it.
-      # If there is no created at data or <tt>:force => true</tt> is passed,
-      # updates the info and returns it
-      def created_at(opts={})
-        update_info if @created_at.nil? || opts[:force]
-        @created_at
-      end
-
-      def clicks_by_minute(opts={})
-        if @clicks_by_minute.nil? || opts[: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(opts={})
-        if @clicks_by_day.nil? || opts[:force]
-          full_url = @client.clicks_by_day(@user_hash || @short_url)
-          @clicks_by_day = full_url.clicks_by_day
-        end
-        @clicks_by_day
-      end
-
-      def jmp_url
-        @short_url.nil? ? nil : @short_url.gsub(/bit\.ly/,'j.mp')
-      end
-
-      # QR code is automatically created and can be incorporated
-      # into mobile applications.
-      def qrcode_url(opts={})
-        qrcode = opts.has_key?(:s) ? ".qrcode?s=#{opts[:s]}" : ".qrcode"
-        @short_url + qrcode
-      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
-        @created_at = full_url.created_at
-      end
-
-      def update_referrers
-        full_url = @client.referrers(@user_hash || @short_url)
-        @referrers = full_url.referrers
-      end
-
-      def update_countries
-        full_url = @client.countries(@user_hash || @short_url)
-        @countries = full_url.countries
-      end
-    end
-  end
-end

data/lib/bitly/v3/user.rb

@@ -1,135 +0,0 @@
-module Bitly
-  module V3
-    # A user requires an oauth access token. The flow is as follows:
-    #
-    #     o = Bitly::V3::OAuth.new(consumer_token, consumer_secret)
-    #     o.authorize_url(redirect_url)
-    #     #=> "https://bit.ly/oauth/authorize?client_id=#{consumer_token}&type=web_server&redirect_uri=http%3A%2F%2Ftest.local%2Fbitly%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:
-    #
-    #     o.get_access_token_from_code(params[:code], redirect_url)
-    #     #=> #<OAuth2::AccessToken ...>
-    #
-    # Then use that access token to create your user object.
-    #
-    #    u=Bitly::V3::User.new(o.access_token)
-    class User
-      include HTTParty
-      base_uri 'https://api-ssl.bit.ly/v3/'
-      attr_accessor :login, :api_key
-
-      def initialize(access_token)
-        @access_token = access_token
-        @login = access_token['login'] || access_token['username']
-        @api_key = access_token['apiKey'] || access_token['api_key']
-      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(opts={})
-        if @referrers.nil? || opts.delete(:force)
-          @referrers = get_method(:referrers, Bitly::V3::Referrer, opts)
-        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(opts={})
-        if @countries.nil? || opts.delete(:force)
-          @countries = get_method(:countries, Bitly::V3::Country, opts)
-        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(opts={})
-        if @realtime_links.nil? || opts.delete(:force)
-          opts.merge!(:access_token => @access_token.token)
-          result = self.class.get("/user/realtime_links", :query => opts)
-          if result['status_code'] == 200
-            @realtime_links = result['data']['realtime_links'].map { |rs| Bitly::V3::RealtimeLink.new(rs) }
-          else
-            raise BitlyError.new(result['status_txt'], result['status_code'])
-          end
-        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(opts={})
-        get_clicks(opts)
-        @clicks
-      end
-
-      # Displays the total clicks returned from the clicks method.
-      def total_clicks(opts={})
-        get_clicks(opts)
-        @total_clicks
-      end
-
-      # Returns a Bitly Client using the credentials of the user.
-      def client
-        @client ||= Bitly::V3::Client.new(login, api_key)
-      end
-
-      # OAuth 2 endpoint that provides a given user's link shortening history,
-      # in reverse chronological order (most recent to least recent).
-      def link_history(opts={})
-        opts.merge!(:access_token => @access_token.token)
-        result = self.class.get("/user/link_history", :query => opts)
-        if result['status_code'] == 200
-          results = result['data']['link_history'].inject([]) do |rs, obj|
-            obj['short_url'] = obj['link']
-            obj['hash'] = obj['link'].split('/').last
-            rs << Url.new(client, obj)
-          end
-          return results
-        else
-          raise BitlyError.new(result['status_txt'], result['status_code'])
-        end
-      end
-
-      private
-
-      def get_method(method, klass, opts)
-        opts.merge!(:access_token => @access_token.token)
-        result = self.class.get("/user/#{method.to_s}", :query => opts)
-        if result['status_code'] == 200
-          results = result['data'][method.to_s].map do |rs|
-            rs.inject([]) do |results, obj|
-              results << klass.new(obj)
-            end
-          end
-          return results
-        else
-          raise BitlyError.new(result['status_txt'], result['status_code'])
-        end
-      end
-
-      def get_clicks(opts={})
-        if @clicks.nil? || opts.delete(:force)
-          opts.merge!(:access_token => @access_token.token)
-          result = self.class.get("/user/clicks", :query => opts)
-          if result['status_code'] == 200
-            @clicks = result['data']['clicks'].map { |rs| Bitly::V3::Day.new(rs) }
-            @total_clicks = result['data']['total_clicks']
-          else
-            raise BitlyError.new(result['status_txt'], result['status_code'])
-          end
-        end
-      end
-    end
-  end
-end

data/test/bitly/test_client.rb

@@ -1,266 +0,0 @@
-require File.join(File.dirname(__FILE__), '..', 'test_helper.rb')
-
-class TestClient < Minitest::Test
-  context "bitly module" do
-    setup do
-      Bitly.api_version = nil
-    end
-
-    should "create a new bitly client" do
-      b = Bitly.new(login, api_key)
-      assert_equal Bitly::Client, b.class
-    end
-
-    should "create a new bitly client with generic OAuth2 access token" do
-      b = Bitly.new(access_token)
-      assert_equal Bitly::Client, b.class
-    end
-
-    should "create a new bitly client and configure with a block" do
-      Bitly.configure do |config|
-        config.api_key = api_key
-        config.login = login
-      end
-      b = Bitly.client
-      assert_kind_of Bitly::Client, b
-      assert_equal api_key, b.api_key
-      assert_equal login, b.login
-    end
-
-    should "create a proper OAuth2 authorization url" do
-      client = Bitly::V3::OAuth.new('CLIENT_ID', 'CLIENT_SECRET')
-      url = client.authorize_url('http://www.example.com/oauth_callback')
-      assert_equal "https://bitly.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_callback&response_type=code", url
-    end
-
-    should "create a proper OAuth2 authorization url with a state parameter" do
-      client = Bitly::V3::OAuth.new('CLIENT_ID', 'CLIENT_SECRET')
-      url = client.authorize_url('http://www.example.com/oauth_callback', 'some_state')
-      assert_equal "https://bitly.com/oauth/authorize?client_id=CLIENT_ID&redirect_uri=http%3A%2F%2Fwww.example.com%2Foauth_callback&response_type=code&state=some_state", url
-    end
-
-    context "setting api versions" do
-      teardown do
-        Bitly.api_version = nil
-      end
-
-      should "set the api version to 2" do
-        Bitly.use_api_version_2
-        assert_equal Bitly.api_version, 2
-        assert_kind_of Bitly::Client, Bitly.client
-      end
-
-      should "set the api version to 3" do
-        Bitly.use_api_version_3
-        assert_equal Bitly.api_version, 3
-        assert_kind_of Bitly::V3::Client, Bitly.client
-      end
-    end
-  end
-  context "using the bitly client" do
-    setup do
-      Bitly.use_api_version_2
-      @bitly = Bitly.new(login, api_key)
-    end
-
-    context "shortening" do
-      context "a single link" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/shorten\?.*longUrl=.*cnn.com.*$/,"cnn.json")
-          @url = @bitly.shorten('http://cnn.com')
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return a short bitly url" do
-          assert_equal "http://bit.ly/15DlK", @url.short_url
-          assert_equal "http://bit.ly/15DlK", @url.bitly_url
-        end
-        should "return a short jmp url" do
-          assert_equal "http://j.mp/15DlK", @url.jmp_url
-        end
-        should "save the long url" do
-          assert_equal "http://cnn.com", @url.long_url
-        end
-      end
-      context "multiple links" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/shorten\?.*longUrl=.*longUrl=.*$/,"cnn_and_google.json")
-          @urls = @bitly.shorten(['http://cnn.com', 'http://google.com'])
-        end
-        should "return an array of Bitly::Urls" do
-          assert_kind_of Array, @urls
-          assert_kind_of Bitly::Url, @urls[0]
-        end
-        should "shorten the urls in order" do
-          assert_equal "http://bit.ly/15DlK", @urls[0].short_url
-          assert_equal "http://bit.ly/11etr", @urls[1].short_url
-        end
-        should "save the long urls" do
-          assert_equal "http://cnn.com", @urls[0].long_url
-          assert_equal "http://google.com", @urls[1].long_url
-        end
-      end
-      context "no links" do
-        should "raise an ArgumentError" do
-          assert_raises ArgumentError do
-            @bitly.shorten
-          end
-        end
-      end
-    end
-    context "expanding" do
-      context "a hash" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
-          @url = @bitly.expand("31IqMl")
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return the expanded url" do
-          assert_equal "http://cnn.com/", @url.long_url
-        end
-        should "save the hash" do
-          assert_equal "31IqMl", @url.hash
-        end
-        should "save the short url" do
-          assert_equal "http://bit.ly/31IqMl", @url.short_url
-        end
-      end
-      context "a short bitly url" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
-          @url = @bitly.expand("http://bit.ly/31IqMl")
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return the expanded url" do
-          assert_equal "http://cnn.com/", @url.long_url
-        end
-        should "save the hash" do
-          assert_equal "31IqMl", @url.hash
-        end
-        should "save the bitly url" do
-          assert_equal "http://bit.ly/31IqMl", @url.bitly_url
-        end
-        should "save a jmp url" do
-          assert_equal "http://j.mp/31IqMl", @url.jmp_url
-        end
-      end
-      context "a short jmp url" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/expand\?.*hash=31IqMl.*$/,"expand_cnn.json")
-          @url = @bitly.expand("http://j.mp/31IqMl")
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return the expanded url" do
-          assert_equal "http://cnn.com/", @url.long_url
-        end
-        should "save the hash" do
-          assert_equal "31IqMl", @url.hash
-        end
-        should "save the bitly url" do
-          assert_equal "http://bit.ly/31IqMl", @url.bitly_url
-        end
-        should "save a jmp url" do
-          assert_equal "http://j.mp/31IqMl", @url.jmp_url
-        end
-      end
-      context "multiple hashes" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/expand\?.*hash=15DlK.*3j4ir4.*$/,"expand_cnn_and_google.json")
-          @urls = @bitly.expand(["15DlK","3j4ir4"])
-        end
-        should "return an array of Bitly::Urls" do
-          assert_kind_of Array, @urls
-          assert_kind_of Bitly::Url, @urls[0]
-          assert_kind_of Bitly::Url, @urls[1]
-        end
-        should "expand the hashes in order" do
-          assert_equal "http://cnn.com/", @urls[0].long_url
-          assert_equal "http://google.com/", @urls[1].long_url
-        end
-        should "save the hash to each url" do
-          assert_equal "15DlK", @urls[0].hash
-          assert_equal "3j4ir4", @urls[1].hash
-        end
-      end
-    end
-    context "to get info on" do
-      context "a single link" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/info\?.*hash=3j4ir4.*$/,"google_info.json")
-          @url = @bitly.info('http://bit.ly/3j4ir4')
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return an info object with the url" do
-          assert !@url.info.nil?
-        end
-      end
-      context "a single hash" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/info\?.*hash=3j4ir4.*$/,"google_info.json")
-          @url = @bitly.info('3j4ir4')
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return an info object with the url" do
-          assert !@url.info.nil?
-        end
-      end
-      context "a list of hashes" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/info\?.*hash=3j4ir4.*31IqMl.*$/,"google_and_cnn_info.json")
-          @urls = @bitly.info(['3j4ir4','31IqMl'])
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Array, @urls
-        end
-        should "return an info object with the url" do
-          assert !@urls[0].info.nil?
-          assert !@urls[1].info.nil?
-        end
-      end
-    end
-    context "to get stats on" do
-      context "a single link" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
-          @url = @bitly.stats('http://bit.ly/3j4ir4')
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return an stats object" do
-          assert !@url.stats.nil?
-        end
-      end
-      context "a single hash" do
-        setup do
-          stub_get(/^https:\/\/api-ssl\.bitly\.com\/stats\?.*hash=3j4ir4.*$/,"google_stats.json")
-          @url = @bitly.stats('3j4ir4')
-        end
-        should "return a Bitly::Url" do
-          assert_kind_of Bitly::Url, @url
-        end
-        should "return an stats object" do
-          assert !@url.stats.nil?
-        end
-      end
-      context "a list of hashes" do
-        should "return an argument error" do
-          assert_raises ArgumentError do
-            @bitly.stats(['3j4ir4','31IqMl'])
-          end
-        end
-      end
-    end
-  end
-end