tinybucket2 1.0.0

data/Rakefile

@@ -0,0 +1,47 @@
+require 'rubygems'
+require 'bundler/setup'
+
+require "bundler/gem_tasks"
+
+desc 'cleanup rcov, doc directories'
+task :clean do
+  rm_rf 'coverage'
+  rm_rf 'doc'
+  rm_rf 'measurement'
+end
+
+# https://github.com/sferik/twitter/blob/master/Rakefile
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :test => :spec
+
+if Dir.exist?('./features')
+  RSpec::Core::RakeTask.new(:features) do |t|
+    t.pattern = './features/**/*_spec.rb'
+    t.rspec_opts = '-I ./features'
+  end
+end
+
+begin
+  require 'rubocop/rake_task'
+  RuboCop::RakeTask.new
+rescue LoadError
+  task :rubocop do
+    $stderr.puts 'Rubocop is disabled.'
+  end
+end
+
+require 'yard'
+YARD::Rake::YardocTask.new
+
+require 'yardstick/rake/measurement'
+Yardstick::Rake::Measurement.new do |measurement|
+  measurement.output = 'measurement/report.txt'
+end
+
+require 'yardstick/rake/verify'
+Yardstick::Rake::Verify.new do |verify|
+  verify.threshold = 59.6
+end
+
+task :default => [:spec, :rubocop]

data/lib/faraday_middleware/follow_oauth_redirects.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+require 'faraday'
+require 'faraday_middleware'
+
+module FaradayMiddleware
+  class FollowOAuthRedirects < FollowRedirects
+    dependency 'simple_oauth'
+
+    AUTH_HEADER = OAuth::AUTH_HEADER
+    CONTENT_TYPE = OAuth::CONTENT_TYPE
+    TYPE_URLENCODED = OAuth::TYPE_URLENCODED
+
+    def update_env(env, request_body, response)
+      env = super(env, request_body, response)
+
+      # update Authentication Header
+      if oauth_signed_request?(env)
+        env[:request_headers][OAuth::AUTH_HEADER] = oauth_header(env).to_s
+      end
+
+      env
+    end
+
+    def oauth_header(env)
+      SimpleOAuth::Header.new env[:method],
+                              env[:url].to_s,
+                              signature_params(body_params(env)),
+                              oauth_options(env)
+    end
+
+    def oauth_signed_request?(env)
+      env[:request].oauth
+    end
+
+    def oauth_options(env)
+      extra = env[:request][:oauth]
+      if extra.present? and extra.is_a? Hash and !extra.empty?
+        @options.merge extra
+      else
+        @options
+      end
+    end
+
+    def body_params(env)
+      if include_body_params?(env)
+        if env[:body].respond_to?(:to_str)
+          ::Faraday::Utils.parse_nested_query env[:body]
+        else
+          env[:body]
+        end
+      end || {}
+    end
+
+    def include_body_params?(env)
+      # see RFC 5849, section 3.4.1.3.1 for details
+      !(type = env[:request_headers][OAuth::CONTENT_TYPE]) ||
+        type == OAuth::TYPE_URLENCODED
+    end
+
+    def signature_params(params)
+      return params if params.empty?
+      params.reject { |_k, v| v.respond_to?(:content_type) }
+    end
+  end
+
+  if Faraday::Middleware.respond_to? :register_middleware
+    Faraday::Response.register_middleware \
+      follow_oauth_redirects: -> { FollowOAuthRedirects }
+  end
+end

data/lib/tinybucket.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+require 'tinybucket/version'
+
+require 'active_support/dependencies/autoload'
+
+require 'active_support/core_ext/hash'
+require 'active_support/configurable'
+require 'active_support/inflector'
+
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/response_middleware'
+require 'faraday_middleware/follow_oauth_redirects'
+require 'faraday-http-cache'
+
+require 'active_model'
+
+require 'logger'
+require 'uri'
+
+require 'tinybucket/enumerator'
+require 'tinybucket/iterator'
+
+require 'tinybucket/config'
+require 'tinybucket/null_logger'
+require 'tinybucket/api'
+require 'tinybucket/api_factory'
+require 'tinybucket/api/helper'
+require 'tinybucket/connection'
+require 'tinybucket/constants'
+require 'tinybucket/error'
+require 'tinybucket/model/concerns'
+require 'tinybucket/model'
+require 'tinybucket/parser'
+require 'tinybucket/request'
+require 'tinybucket/resource'
+require 'tinybucket/response'
+
+require 'tinybucket/client'
+
+require 'active_support/notifications'
+ActiveSupport::Notifications.subscribe('request.faraday') \
+  do |_name, start_time, end_time, _, env|
+    url = env[:url]
+    http_method = env[:method].to_s.upcase
+    duration = end_time - start_time
+    Tinybucket.logger.debug \
+      format(
+        '[%s] %s %s (%.3f s)',
+        url.host, http_method, url.request_uri, duration
+      )
+  end
+
+module Tinybucket
+  class << self
+    include ActiveSupport::Configurable
+    attr_accessor :logger, :api_client
+
+    def new
+      @api_client = Tinybucket::Client.new
+    end
+
+    def configure
+      yield(config)
+    end
+
+    def config
+      @config ||= Tinybucket::Config.new
+    end
+
+    def logger
+      config.logger || Tinybucket::NullLogger.new
+    end
+  end
+end

data/lib/tinybucket/api.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    extend ActiveSupport::Autoload
+
+    [
+      :BaseApi,
+      :BranchesApi,
+      :IssuesApi,
+      :BranchRestrictionsApi,
+      :BuildStatusApi,
+      :CommitsApi,
+      :CommentsApi,
+      :DiffApi,
+      :ProjectsApi,
+      :PullRequestsApi,
+      :ReposApi,
+      :RepoApi,
+      :TeamApi,
+      :UserApi
+    ].each do |klass_name|
+      autoload klass_name
+    end
+  end
+end

data/lib/tinybucket/api/base_api.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    class Parser
+      attr_reader :type, :options
+
+      def initialize(type, model_class)
+        parser_class =
+          case type
+          when :collection then Tinybucket::Parser::CollectionParser
+          when :object     then Tinybucket::Parser::ObjectParser
+          else throw "Unknown parser type: #{type}"
+          end
+
+        @type = parser_class
+        @options = { model_class: model_class }
+      end
+    end
+
+    class BaseApi
+      include Tinybucket::Connection
+      include Tinybucket::Request
+
+      protected
+
+      #
+      # Get parser
+      #
+      # @param type [Symbol] :collection or :object
+      # @param model_class [Tinybucket::Model::Base] SubClass of Tinybucket::Model::Base
+      # @return [Hash]
+      def get_parser(type, model_class)
+        Tinybucket::Api::Parser.new(type, model_class)
+      end
+
+      private
+
+      def logger
+        Tinybucket.logger
+      end
+    end
+  end
+end

data/lib/tinybucket/api/branch_restrictions_api.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # BranchRestrictions API client
+    #
+    # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/branch-restrictions
+    #   branch-restrictions Resource
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
+    class BranchRestrictionsApi < BaseApi
+      include Tinybucket::Api::Helper::BranchRestrictionsHelper
+
+      attr_accessor :repo_owner, :repo_slug
+
+      # Send 'GET the branch-restrictions' request.
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/branch-restrictions#get
+      #   GET the branch-restrictions
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        get_path(
+          path_to_list,
+          options,
+          get_parser(:collection, Tinybucket::Model::BranchRestriction)
+        )
+      end
+
+      # Send 'GET a specific restriction' request.
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/branch-restrictions/%7Bid%7D#get
+      #   GET a specific restriction
+      #
+      # @param restriction_id [String] The restriction's identifier
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BranchRestriction]
+      def find(restriction_id, options = {})
+        get_path(
+          path_to_find(restriction_id),
+          options,
+          get_parser(:object, Tinybucket::Model::BranchRestriction)
+        )
+      end
+    end
+  end
+end

data/lib/tinybucket/api/branches_api.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # Branches Api client
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repo_slug}.
+    class BranchesApi < BaseApi
+      include Tinybucket::Api::Helper::BranchesHelper
+
+      attr_accessor :repo_owner, :repo_slug
+
+      # Send 'GET a branches list for a repository' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches#get
+      #   GET a branches list for a repository
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        get_path(
+          path_to_list,
+          options,
+          get_parser(:collection, Tinybucket::Model::Branch)
+        )
+      end
+
+      # Send 'GET an individual branch' request
+      #
+      # @see https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/refs/branches/%7Bname%7D#get
+      #   GET an individual branch
+      #
+      # @param name [String] The branch name
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Branch]
+      def find(name, options = {})
+        get_path(
+          path_to_find(name),
+          options,
+          get_parser(:object, Tinybucket::Model::Branch)
+        )
+      end
+    end
+  end
+end

data/lib/tinybucket/api/build_status_api.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # BuildStatus Api client
+    #
+    # @see https://confluence.atlassian.com/bitbucket/statuses-build-resource-779295267.html
+    #   statuses/build Resource - Bitbucket Cloud REST API
+    class BuildStatusApi < BaseApi
+      include Tinybucket::Api::Helper::BuildStatusHelper
+
+      attr_accessor :revision, :repo_owner, :repo_slug
+
+      # Send 'GET a builds list for a commit' request
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        get_path(
+          path_to_list,
+          options,
+          get_parser(:collection, Tinybucket::Model::BuildStatus)
+        )
+      end
+
+      # Send 'GET the build status for a commit' request
+      #
+      # @param revision [String]
+      # @param key [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BuildStatus]
+      def find(revision, key, options = {})
+        get_path(
+          path_to_find(revision, key),
+          options,
+          get_parser(:object, Tinybucket::Model::BuildStatus)
+        )
+      end
+
+      # Send 'POST a build status for a commit' request
+      #
+      # @param revision [String]
+      # @param key [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BuildStatus]
+      def post(revision, key, options)
+        post_path(
+          path_to_post(revision),
+          options.merge(key: key),
+          get_parser(:object, Tinybucket::Model::BuildStatus)
+        )
+      end
+
+      # Send 'PUT a build status for a commit' request
+      #
+      # @param revision [String]
+      # @param key [String]
+      # @param options [Hash]
+      # @return [Tinybucket::Model::BuildStatus]
+      def put(revision, key, options)
+        put_path(
+          path_to_put(revision, key),
+          options,
+          get_parser(:object, Tinybucket::Model::BuildStatus)
+        )
+      end
+    end
+  end
+end

data/lib/tinybucket/api/comments_api.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Tinybucket
+  module Api
+    # Comments Api client
+    #
+    # @!attribute [rw] repo_owner
+    #   @return [String] repository owner name.
+    # @!attribute [rw] repo_slug
+    #   @return [String] {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D repository slug}.
+    # @!attribute [rw] commented_to
+    #   @return [Tinybucket::Model::Commit, Tinybucket::Model::PullRequest]
+    class CommentsApi < BaseApi
+      include Tinybucket::Api::Helper::CommentsHelper
+
+      attr_accessor :repo_owner, :repo_slug
+
+      attr_accessor :commented_to
+
+      # Send 'GET a list of comments' request.
+      #
+      # This method send different request depend on 'commented_to' attribute.
+      #
+      # @note When 'commented_to' is {Tinybucket::Model::Commit} instance,
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments#get
+      #   GET a list of commit comments}.
+      # @note When 'commented_to' is {Tinybucket::Model::PullRequest} instance,
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments#get
+      #   GET a list of pull request comments}.
+      #
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Page]
+      def list(options = {})
+        list = get_path(path_to_list,
+                        options,
+                        get_parser(:collection, Tinybucket::Model::Comment))
+
+        associate_with_target(list)
+        list
+      end
+
+      # Send 'GET a individual comment' request.
+      #
+      # This method send different request depend on 'commented_to' attribute.
+      #
+      # @note When 'commented_to' is {Tinybucket::Model::Commit} instance,
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments/%7Bcomment_id%7D#get
+      #   GET an individual commit comment}.
+      # @note When 'commented_to' is {Tinybucket::Model::PullRequest} instance,
+      #   this method send {https://developer.atlassian.com/bitbucket/api/2/reference/resource/repositories/%7Busername%7D/%7Brepo_slug%7D/commit/%7Bsha%7D/comments/%7Bcomment_id%7D#get
+      #   GET an individual pull request comment}.
+      #
+      # @param comment_id [String] comment identifier
+      # @param options [Hash]
+      # @return [Tinybucket::Model::Comment]
+      def find(comment_id, options = {})
+        comment = get_path(path_to_find(comment_id),
+                           options,
+                           get_parser(:object, Tinybucket::Model::Comment))
+
+        associate_with_target(comment)
+        comment
+      end
+
+      private
+
+      def associate_with_target(result)
+        case result
+        when Tinybucket::Model::Comment
+          result.commented_to = commented_to
+        when Tinybucket::Model::Page
+          result.items.map { |m| m.commented_to = commented_to }
+        else
+          raise ArgumentError, "Invalid result: #{result.inspect}"
+        end
+
+        result
+      end
+    end
+  end
+end