codenamev_bitbucket_api 0.4.0

data/lib/bitbucket_rest_api/utils/url.rb

@@ -0,0 +1,56 @@
+require 'cgi'
+
+module BitBucket
+  module Utils
+    module Url
+      extend self
+
+      DEFAULT_QUERY_SEP = /[&;] */n
+
+      KEY_VALUE_SEP = '='.freeze
+
+      def escape(s) CGI.escape s.to_s end
+
+      def unescape(s) CGI.unescape s.to_s end
+
+      def build_query(params)
+        params.map { |k, v|
+          if v.class == Array
+            build_query(v.map { |x| [k, x] })
+          else
+            v.nil? ? escape(k) : "#{escape(k)}=#{escape(v)}"
+          end
+        }.join("&")
+      end
+
+      def parse_query(query_string)
+        return '' if query_string.nil? || query_string.empty?
+        params = {}
+
+        query_string.split(DEFAULT_QUERY_SEP).each do |part|
+          k, v = part.split(KEY_VALUE_SEP, 2).map { |el| unescape(el) }
+
+          if cur = params[k]
+            if cur.class == Array
+              params[k] << v
+            else
+              params[k] = [cur, v]
+            end
+          else
+            params[k] = v
+          end
+        end
+        params
+      end
+
+      def parse_query_for_param(query_string, name)
+        parse_query(query_string).each do |key, val|
+          return val.first if (name == key) && val.is_a?(Array)
+          return val if (name == key)
+        end
+        return nil
+      end
+
+    end # Url
+  end # Utils
+end # BitBucket

data/lib/bitbucket_rest_api/validations/format.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module BitBucket
+  module Validations
+    module Format
+
+      # Ensures that value for a given key is of the correct form whether
+      # matching regular expression or set of predefined values.
+      #
+      def assert_valid_values(permitted, params)
+        params.each do |k, v|
+          next unless permitted.keys.include?(k)
+          if permitted[k].is_a?(Array) && !permitted[k].include?(params[k])
+            raise BitBucket::Error::UnknownValue.new(k,v, permitted[k].join(', '))
+
+          elsif permitted[k].is_a?(Regexp) && !(permitted[k] =~ params[k])
+            raise BitBucket::Error::UnknownValue.new(k,v, permitted[k])
+          end
+        end
+      end
+
+    end # Format
+  end # Validations
+end # BitBucket

data/lib/bitbucket_rest_api/validations/presence.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+module BitBucket
+  module Validations
+    # A mixin to help validate presence of non-empty values
+    module Presence
+
+      # Ensure that esential arguments are present before request is made.
+      #
+      # == Parameters
+      #  Hash/Array of arguments to be checked against nil and empty string
+      #
+      # == Example
+      #  assert_presence_of user: '...', repo: '...'
+      #  assert_presence_of user, repo
+      #
+      def assert_presence_of(*args)
+        hash = args.last.is_a?(::Hash) ? args.pop : {}
+
+        errors = hash.select { |key, val| val.to_s.empty? }
+        raise Github::Error::Validations.new(errors) unless errors.empty?
+
+        args.each do |arg|
+          raise ArgumentError, "parameter cannot be nil" if arg.nil?
+        end
+      end
+
+    end # Presence
+  end # Validations
+end # BitBucket

data/lib/bitbucket_rest_api/validations/required.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module BitBucket
+  module Validations
+    module Required
+
+      # Validate all keys present in a provided hash against required set,
+      # on mismatch raise BitBucket::Error::RequiredParams
+      # Note that keys need to be in the same format i.e. symbols or strings,
+      # otherwise the comparison will fail.
+      #
+      def assert_required_keys(required, provided)
+        result = required.all? do |key|
+          provided.has_deep_key? key
+        end
+        if !result
+          raise BitBucket::Error::RequiredParams.new(provided, required)
+        end
+        result
+      end
+
+    end # Required
+  end # Validations
+end # BitBucket

data/lib/bitbucket_rest_api/validations/token.rb

@@ -0,0 +1,43 @@
+# encoding: utf-8
+
+# TODO: Set token required calls
+
+module BitBucket
+  module Validations
+    module Token
+
+      TOKEN_REQUIRED = [
+          'get /user',
+          'get /user/emails',
+          'get /user/followers',
+          'get /user/following',
+          'get /user/keys',
+          'get /user/repos',
+          'patch /user',
+          'post /user/emails',
+          'post /user/keys',
+          'post /user/repos'
+      ]
+
+      TOKEN_REQUIRED_REGEXP = [
+          /repos\/.*\/.*\/comments/,
+      ]
+
+      # Ensures that required authentication token is present before
+      # request is sent.
+      #
+      def validates_token_for(method, path)
+        return true unless TOKEN_REQUIRED.grep("#{method} #{path}").empty?
+
+        token_required = false
+        TOKEN_REQUIRED_REGEXP.each do |regex|
+          if "#{method} #{path}" =~ regex
+            token_required = true
+          end
+        end
+        return token_required
+      end
+
+    end # Token
+  end # Validations
+end # BitBucket

data/lib/bitbucket_rest_api/validations.rb

@@ -0,0 +1,25 @@
+# encoding: utf-8
+
+module BitBucket
+  module Validations
+
+    BitBucket::require_all 'bitbucket_rest_api/validations',
+      'presence',
+      'token',
+      'format',
+      'required'
+
+    include Presence
+    include Format
+    include Token
+    include Required
+
+    VALID_API_KEYS = [
+        'page',
+        'per_page',
+        'auto_pagination',
+        'jsonp_callback'
+    ]
+
+  end # Validation
+end # BitBucket

data/lib/bitbucket_rest_api/version.rb

@@ -0,0 +1,11 @@
+# encoding: utf-8
+
+module BitBucket
+  module VERSION
+    MAJOR = 0
+    MINOR = 4
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end # BitBucket

data/lib/bitbucket_rest_api.rb

@@ -0,0 +1,136 @@
+# encoding: utf-8
+
+require 'faraday'
+require 'faraday_middleware'
+require 'bitbucket_rest_api/version'
+require 'bitbucket_rest_api/configuration'
+require 'bitbucket_rest_api/constants'
+require 'bitbucket_rest_api/utils/url'
+require 'bitbucket_rest_api/connection'
+require 'bitbucket_rest_api/deprecation'
+require 'bitbucket_rest_api/core_ext/ordered_hash'
+require 'bitbucket_rest_api/ext/faraday'
+require 'bitbucket_rest_api/middleware'
+
+module BitBucket
+  LIBNAME = 'bitbucket_rest_api'
+
+  LIBDIR = File.expand_path("../#{LIBNAME}", __FILE__)
+
+  class << self
+    def included(base)
+      base.extend ClassMethods
+    end
+
+    # Handle for the client instance
+    attr_accessor :api_client
+
+    # Alias for BitBucket::Client.new
+    #
+    # @return [BitBucket::Client]
+    def new(options = { }, &block)
+      @api_client = Client.new(options, &block)
+    end
+
+    # Default middleware stack that uses default adapter as specified
+    # by configuration setup
+    #
+    # @return [Proc]
+    #
+    # @api private
+    def default_middleware(options = {})
+      Middleware.default(options)
+    end
+
+    # Delegate to BitBucket::Client
+    #
+    def method_missing(method, *args, &block)
+      return super unless new.respond_to?(method)
+      new.send(method, *args, &block)
+    end
+
+    def respond_to?(method, include_private = false)
+      new.respond_to?(method, include_private) || super(method, include_private)
+    end
+
+  end
+
+  module ClassMethods
+
+    # Requires internal libraries
+    #
+    # @param [String] prefix
+    #   the relative path prefix
+    # @param [Array[String]] libs
+    #   the array of libraries to require
+    #
+    # @return [self]
+    def require_all(prefix, *libs)
+      libs.each do |lib|
+        require "#{File.join(prefix, lib)}"
+      end
+    end
+
+    # The client configuration
+    #
+    # @return [Configuration]
+    #
+    # @api public
+    def configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Configure options
+    #
+    # @example
+    #   BitBucket.configure do |c|
+    #     c.some_option = true
+    #   end
+    #
+    # @yield the configuration block
+    # @yieldparam configuration [BitBucket::Configuration]
+    #   the configuration instance
+    #
+    # @return [nil]
+    #
+    # @api public
+    def configure
+      yield configuration
+    end
+  end
+
+  extend ClassMethods
+
+  require_all LIBDIR,
+    'authorization',
+    'validations',
+    'normalizer',
+    'parameter_filter',
+    'api',
+    'client',
+    'pagination',
+    'request',
+    'response',
+    'response_wrapper',
+    #'result',
+    'error',
+    'page_links',
+    'paged_request',
+    'page_iterator',
+    'params_hash'
+
+    #'repos',
+    #'issues',
+    #'user',
+    #'users',
+    #'invitations',
+    #'page_links',
+    #'paged_request',
+    #'page_iterator'
+
+    #'teams',
+    #'users',
+    #'events',
+    #'search',
+
+end # BitBucket

metadata

@@ -0,0 +1,238 @@
+--- !ruby/object:Gem::Specification
+name: codenamev_bitbucket_api
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+platform: ruby
+authors:
+- Mike Cochran
+- Valentino Stoll
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-05-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+- !ruby/object:Gem::Dependency
+  name: simple_oauth
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: " Ruby wrapper for the BitBucket API supporting OAuth and Basic Authentication "
+email: v@codenamev.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/bitbucket_rest_api.rb
+- lib/bitbucket_rest_api/api.rb
+- lib/bitbucket_rest_api/api/actions.rb
+- lib/bitbucket_rest_api/api/arguments.rb
+- lib/bitbucket_rest_api/api/config.rb
+- lib/bitbucket_rest_api/api/config/property.rb
+- lib/bitbucket_rest_api/api/config/property_set.rb
+- lib/bitbucket_rest_api/api/factory.rb
+- lib/bitbucket_rest_api/authorization.rb
+- lib/bitbucket_rest_api/client.rb
+- lib/bitbucket_rest_api/client/invitations.rb
+- lib/bitbucket_rest_api/client/issues.rb
+- lib/bitbucket_rest_api/client/issues/comments.rb
+- lib/bitbucket_rest_api/client/issues/components.rb
+- lib/bitbucket_rest_api/client/issues/milestones.rb
+- lib/bitbucket_rest_api/client/repos.rb
+- lib/bitbucket_rest_api/client/repos/changesets.rb
+- lib/bitbucket_rest_api/client/repos/following.rb
+- lib/bitbucket_rest_api/client/repos/keys.rb
+- lib/bitbucket_rest_api/client/repos/pull_requests.rb
+- lib/bitbucket_rest_api/client/repos/pull_requests/comments.rb
+- lib/bitbucket_rest_api/client/repos/pull_requests/commits.rb
+- lib/bitbucket_rest_api/client/repos/services.rb
+- lib/bitbucket_rest_api/client/repos/sources.rb
+- lib/bitbucket_rest_api/client/user.rb
+- lib/bitbucket_rest_api/client/users.rb
+- lib/bitbucket_rest_api/client/users/account.rb
+- lib/bitbucket_rest_api/compatibility.rb
+- lib/bitbucket_rest_api/configuration.rb
+- lib/bitbucket_rest_api/connection.rb
+- lib/bitbucket_rest_api/constants.rb
+- lib/bitbucket_rest_api/core_ext/array.rb
+- lib/bitbucket_rest_api/core_ext/hash.rb
+- lib/bitbucket_rest_api/core_ext/ordered_hash.rb
+- lib/bitbucket_rest_api/deprecation.rb
+- lib/bitbucket_rest_api/error.rb
+- lib/bitbucket_rest_api/error/bad_request.rb
+- lib/bitbucket_rest_api/error/client_error.rb
+- lib/bitbucket_rest_api/error/forbidden.rb
+- lib/bitbucket_rest_api/error/internal_server_error.rb
+- lib/bitbucket_rest_api/error/invalid_options.rb
+- lib/bitbucket_rest_api/error/not_found.rb
+- lib/bitbucket_rest_api/error/required_params.rb
+- lib/bitbucket_rest_api/error/service_error.rb
+- lib/bitbucket_rest_api/error/service_unavailable.rb
+- lib/bitbucket_rest_api/error/unauthorized.rb
+- lib/bitbucket_rest_api/error/unknown_value.rb
+- lib/bitbucket_rest_api/error/unprocessable_entity.rb
+- lib/bitbucket_rest_api/error/validations.rb
+- lib/bitbucket_rest_api/ext/faraday.rb
+- lib/bitbucket_rest_api/middleware.rb
+- lib/bitbucket_rest_api/normalizer.rb
+- lib/bitbucket_rest_api/null_encoder.rb
+- lib/bitbucket_rest_api/page_iterator.rb
+- lib/bitbucket_rest_api/page_links.rb
+- lib/bitbucket_rest_api/paged_request.rb
+- lib/bitbucket_rest_api/pagination.rb
+- lib/bitbucket_rest_api/parameter_filter.rb
+- lib/bitbucket_rest_api/params_hash.rb
+- lib/bitbucket_rest_api/request.rb
+- lib/bitbucket_rest_api/request/basic_auth.rb
+- lib/bitbucket_rest_api/request/jsonize.rb
+- lib/bitbucket_rest_api/request/oauth.rb
+- lib/bitbucket_rest_api/request/verbs.rb
+- lib/bitbucket_rest_api/response.rb
+- lib/bitbucket_rest_api/response/header.rb
+- lib/bitbucket_rest_api/response/helpers.rb
+- lib/bitbucket_rest_api/response/jsonize.rb
+- lib/bitbucket_rest_api/response/mashify.rb
+- lib/bitbucket_rest_api/response/raise_error.rb
+- lib/bitbucket_rest_api/response/xmlize.rb
+- lib/bitbucket_rest_api/response_wrapper.rb
+- lib/bitbucket_rest_api/result.rb
+- lib/bitbucket_rest_api/users.rb
+- lib/bitbucket_rest_api/utils/url.rb
+- lib/bitbucket_rest_api/validations.rb
+- lib/bitbucket_rest_api/validations/format.rb
+- lib/bitbucket_rest_api/validations/presence.rb
+- lib/bitbucket_rest_api/validations/required.rb
+- lib/bitbucket_rest_api/validations/token.rb
+- lib/bitbucket_rest_api/version.rb
+homepage: https://github.com/codenamev/bitbucket
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Ruby wrapper for the BitBucket API supporting OAuth and Basic Authentication
+test_files: []