bitly 1.1.1 → 2.0.1

data/lib/bitly/oauth.rb

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+require "oauth2"
+require "base64"
+
+module Bitly
+  ##
+  # The Oauth class handles interacting with the Bitly API to setup OAuth flows
+  # to redirect the user to authorize with Bitly and turn the resultant code
+  # into an OAuth access token.
+  class OAuth
+    attr_reader :client_id, :client_secret
+
+    ##
+    # Creates a new Bitly::OAuth client to retrieve user access tokens.
+    #
+    # To initialize a Bitly::OAuth client you need a client_id and client_secret
+    # which you will get when you register your application at
+    # https://bitly.com/a/oauth_apps
+    #
+    # @example
+    #     oauth = Bitly::OAuth.new(client_id: "test", client_secret: "secret")
+    #
+    # @param [String] client_id The client ID from
+    #   https://bitly.com/a/oauth_apps
+    # @param [String] client_secret The client_secret from
+    #   https://bitly.com/a/oauth_apps
+    # @return [Bitly::OAuth] An authenticated Bitly::OAuth instance
+    # @since 2.0.0
+    def initialize(client_id:, client_secret:)
+      @client_id = client_id
+      @client_secret = client_secret
+      @client = OAuth2::Client.new(
+        client_id,
+        client_secret,
+        :site => 'https://api-ssl.bitly.com',
+        :token_url => '/oauth/access_token',
+      )
+    end
+
+    ##
+    # Returns the URL that you need to redirect the user to, so they can give
+    # your app permission to use their Bitly account.
+    #
+    # @example
+    #     oauth.authorize_uri("https://example.com/oauth/redirect")
+    #     # => "https://bitly.com/oauth/authorize?client_id=...&redirect_uri=https://example.com/oauth_page"
+    #
+    # @param [String] redirect_uri The URI you want Bitly to redirect the user
+    #   back to once they are authorized. This should match the redirect_uri
+    #   you set in your Bitly OAuth app.
+    # @param [String] state An optional state that you can pass to the
+    #   authorize URI that will be returned in the redirect.
+    #
+    # @return [String] The authorize URI that you should use to redirect your
+    #   user.
+    # @since 2.0.0
+    def authorize_uri(redirect_uri, state: nil)
+      params = {
+        redirect_uri: redirect_uri,
+        client_id: client_id
+      }
+      params[:state] = state if state
+      @client.authorize_url(**params).gsub(/api-ssl\./,'')
+    end
+
+    ##
+    # When the user is redirected to your redirect URI, Bitly will include a
+    # code parameter. You then use the original redirect URI and the code to
+    # retrieve an access token.
+    #
+    # @example
+    #     oauth.access_token(redirect_uri: "https://example.com/oauth/redirect", "code")
+    #     # => "9646c4f76e32c18f0afad3b3ed9524f3c917775b"
+    def access_token(redirect_uri: nil, code: nil, username: nil, password: nil)
+      begin
+        if redirect_uri && code
+          access_token_from_code(redirect_uri: redirect_uri, code: code)
+        elsif username && password
+          access_token_from_credentials(username: username, password: password)
+        else
+          raise ArgumentError, "not enough arguments, please include a redirect_uri and code or a username and password."
+        end
+      rescue OAuth2::Error => e
+        raise Bitly::Error, Bitly::HTTP::Response.new(status: e.response.status.to_s, body: e.response.body, headers: e.response.headers)
+      end
+    end
+
+    private
+
+    def access_token_from_code(redirect_uri:, code:)
+      @client.get_token(
+        redirect_uri: redirect_uri,
+        code: code
+      ).token
+    end
+
+    def access_token_from_credentials(username:, password:)
+      @client.password.get_token(username, password, {
+        headers: {
+          "Authorization" => "Basic #{authorization_header}"
+        }
+      }).token
+    end
+
+    def authorization_header
+      Base64.strict_encode64("#{client_id}:#{client_secret}")
+    end
+  end
+end

data/lib/bitly/version.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Bitly
-  VERSION = '1.1.1'
+  VERSION = "2.0.1"
 end

metadata

@@ -1,121 +1,107 @@
 --- !ruby/object:Gem::Specification
 name: bitly
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 2.0.1
 platform: ruby
 authors:
 - Phil Nash
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-23 00:00:00.000000000 Z
+date: 2020-06-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: multi_json
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.3'
-- !ruby/object:Gem::Dependency
-  name: httparty
+  name: oauth2
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.7.6
+        version: 0.5.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: oauth2
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '2.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '3.0'
 - !ruby/object:Gem::Dependency
-  name: shoulda
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.5.0
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: flexmock
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.6
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: vcr
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -129,106 +115,91 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: envyable
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.8.3
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.8.3
-description: Use the bit.ly API to shorten or expand URLs
-email: philnash@gmail.com
+        version: '0'
+description: Use the Bitly API version 4 to shorten or expand URLs. Check out the
+  API documentation at https://dev.bitly.com/.
+email:
+- philnash@gmail.com
 executables: []
 extensions: []
-extra_rdoc_files:
-- LICENSE.md
-- README.md
+extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".rspec"
 - ".travis.yml"
+- CODE_OF_CONDUCT.md
 - Gemfile
 - History.txt
 - LICENSE.md
-- Manifest
 - README.md
 - Rakefile
 - bitly.gemspec
+- config/env.yml.example
 - lib/bitly.rb
-- lib/bitly/client.rb
-- lib/bitly/config.rb
-- lib/bitly/url.rb
-- lib/bitly/utils.rb
-- lib/bitly/v3.rb
-- lib/bitly/v3/bitly.rb
-- lib/bitly/v3/client.rb
-- lib/bitly/v3/country.rb
-- lib/bitly/v3/day.rb
-- lib/bitly/v3/missing_url.rb
-- lib/bitly/v3/oauth.rb
-- lib/bitly/v3/realtime_link.rb
-- lib/bitly/v3/referrer.rb
-- lib/bitly/v3/url.rb
-- lib/bitly/v3/user.rb
+- lib/bitly/api.rb
+- lib/bitly/api/base.rb
+- lib/bitly/api/bitlink.rb
+- lib/bitly/api/bitlink/clicks_summary.rb
+- lib/bitly/api/bitlink/deeplink.rb
+- lib/bitly/api/bitlink/link_click.rb
+- lib/bitly/api/bitlink/paginated_list.rb
+- lib/bitly/api/bsd.rb
+- lib/bitly/api/click_metric.rb
+- lib/bitly/api/client.rb
+- lib/bitly/api/group.rb
+- lib/bitly/api/group/preferences.rb
+- lib/bitly/api/list.rb
+- lib/bitly/api/oauth_app.rb
+- lib/bitly/api/organization.rb
+- lib/bitly/api/shorten_counts.rb
+- lib/bitly/api/user.rb
+- lib/bitly/error.rb
+- lib/bitly/http.rb
+- lib/bitly/http/adapters.rb
+- lib/bitly/http/adapters/net_http.rb
+- lib/bitly/http/client.rb
+- lib/bitly/http/request.rb
+- lib/bitly/http/response.rb
+- lib/bitly/oauth.rb
 - lib/bitly/version.rb
-- test/bitly/test_client.rb
-- test/bitly/test_config.rb
-- test/bitly/test_url.rb
-- test/bitly/test_utils.rb
-- test/fixtures/cnn.json
-- test/fixtures/cnn_and_google.json
-- test/fixtures/expand_cnn.json
-- test/fixtures/expand_cnn_and_google.json
-- test/fixtures/google_and_cnn_info.json
-- test/fixtures/google_info.json
-- test/fixtures/google_stats.json
-- test/fixtures/shorten_error.json
-- test/test_helper.rb
-homepage: http://github.com/philnash/bitly
+homepage: https://github.com/philnash/bitly
 licenses:
 - MIT
-metadata: {}
+metadata:
+  bug_tracker_uri: https://github.com/philnash/bitly/issues
+  changelog_uri: https://github.com/philnash/bitly/blob/master/History.txt
+  documentation_uri: https://www.rubydoc.info/gems/bitly/
+  homepage_uri: https://github.com/philnash/bitly
+  source_code_uri: https://github.com/philnash/bitly
 post_install_message: 
-rdoc_options:
-- "--line-numbers"
-- "--title"
-- Bitly
-- "--main"
-- README.md
+rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.8.7
+      version: 2.3.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
-summary: Use the bit.ly API to shorten or expand URLs
-test_files:
-- test/bitly/test_client.rb
-- test/bitly/test_config.rb
-- test/bitly/test_url.rb
-- test/bitly/test_utils.rb
-- test/fixtures/cnn.json
-- test/fixtures/cnn_and_google.json
-- test/fixtures/expand_cnn.json
-- test/fixtures/expand_cnn_and_google.json
-- test/fixtures/google_and_cnn_info.json
-- test/fixtures/google_info.json
-- test/fixtures/google_stats.json
-- test/fixtures/shorten_error.json
-- test/test_helper.rb
+summary: Use the Bitly API to shorten or expand URLs
+test_files: []

data/Manifest

@@ -1,37 +0,0 @@
-Gemfile
-History.txt
-LICENSE.md
-Manifest
-README.md
-Rakefile
-bitly.gemspec
-lib/bitly.rb
-lib/bitly/client.rb
-lib/bitly/config.rb
-lib/bitly/url.rb
-lib/bitly/utils.rb
-lib/bitly/v3.rb
-lib/bitly/v3/bitly.rb
-lib/bitly/v3/client.rb
-lib/bitly/v3/country.rb
-lib/bitly/v3/day.rb
-lib/bitly/v3/missing_url.rb
-lib/bitly/v3/oauth.rb
-lib/bitly/v3/realtime_link.rb
-lib/bitly/v3/referrer.rb
-lib/bitly/v3/url.rb
-lib/bitly/v3/user.rb
-lib/bitly/version.rb
-test/bitly/test_client.rb
-test/bitly/test_config.rb
-test/bitly/test_url.rb
-test/bitly/test_utils.rb
-test/fixtures/cnn.json
-test/fixtures/cnn_and_google.json
-test/fixtures/expand_cnn.json
-test/fixtures/expand_cnn_and_google.json
-test/fixtures/google_and_cnn_info.json
-test/fixtures/google_info.json
-test/fixtures/google_stats.json
-test/fixtures/shorten_error.json
-test/test_helper.rb