bitbucket_rest_api 0.1.0

data/lib/bitbucket_rest_api/result.rb

@@ -0,0 +1,140 @@
+# encoding: utf-8
+
+module BitBucket
+  module Result
+    include BitBucket::Constants
+
+    # TODO Add result counts method to check total items looking at result links
+
+    def ratelimit_limit
+      loaded? ? @env[:response_headers][RATELIMIT_LIMIT] : nil
+    end
+
+    def ratelimit_remaining
+      loaded? ? @env[:response_headers][RATELIMIT_REMAINING] : nil
+    end
+
+    def cache_control
+      loaded? ? @env[:response_headers][CACHE_CONTROL] : nil
+    end
+
+    def content_type
+      loaded? ? @env[:response_headers][CONTENT_TYPE] : nil
+    end
+
+    def content_length
+      loaded? ? @env[:response_headers][CONTENT_LENGTH] : nil
+    end
+
+    def etag
+      loaded? ? @env[:response_headers][ETAG] : nil
+    end
+
+    def date
+      loaded? ? @env[:response_headers][DATE] : nil
+    end
+
+    def location
+      loaded? ? @env[:response_headers][LOCATION] : nil
+    end
+
+    def server
+      loaded? ? @env[:response_headers][SERVER] : nil
+    end
+
+    def status
+      loaded? ? @env[:status] : nil
+    end
+
+    def success?
+      (200..299).include? status
+    end
+
+    # Returns raw body
+    def body
+      loaded? ? @env[:body] : nil
+    end
+
+    def loaded?
+      !!@env
+    end
+
+    # Return page links
+    def links
+      @@links = BitBucket::PageLinks.new(@env[:response_headers])
+    end
+
+    # Iterator like each for response pages. If there are no pages to
+    # iterate over this method will return nothing.
+    def each_page
+      yield self.body
+      while page_iterator.has_next?
+        yield next_page
+      end
+    end
+
+    # Retrives the result of the first page. Returns <tt>nil</tt> if there is
+    # no first page - either because you are already on the first page
+    # or there are no pages at all in the result.
+    def first_page
+      first_request = page_iterator.first
+      self.instance_eval { @env = first_request.env } if first_request
+      self.body
+    end
+
+    # Retrives the result of the next page. Returns <tt>nil</tt> if there is
+    # no next page or no pages at all.
+    def next_page
+      next_request = page_iterator.next
+      self.instance_eval { @env = next_request.env } if next_request
+      self.body
+    end
+
+    # Retrives the result of the previous page. Returns <tt>nil</tt> if there is
+    # no previous page or no pages at all.
+    def prev_page
+      prev_request = page_iterator.prev
+      self.instance_eval { @env = prev_request.env } if prev_request
+      self.body
+    end
+    alias :previous_page :prev_page
+
+    # Retrives the result of the last page. Returns <tt>nil</tt> if there is
+    # no last page - either because you are already on the last page,
+    # there is only one page or there are no pages at all in the result.
+    def last_page
+      last_request = page_iterator.last
+      self.instance_eval { @env = last_request.env } if last_request
+      self.body
+    end
+
+    # Retrives a specific result for a page given page number.
+    # The <tt>page_number</tt> parameter is not validate, hitting a page
+    # that does not exist will return BitBucket API error. Consequently, if
+    # there is only one page, this method returns nil
+    def page(page_number)
+      request = page_iterator.get_page(page_number)
+      self.instance_eval { @env = request.env } if request
+      self.body
+    end
+
+    # Returns <tt>true</tt> if there is another page in the result set,
+    # otherwise <tt>false</tt>
+    def has_next_page?
+      page_iterator.has_next?
+    end
+
+    # Repopulates objects for new values
+    def reset
+      nil
+    end
+
+    private
+
+    # Internally used page iterator
+    def page_iterator # :nodoc:
+      @@page_iterator = BitBucket::PageIterator.new(@env)
+    end
+
+  end # Result
+end # BitBucket

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,25 @@
+# encoding: utf-8
+
+module BitBucket
+  module Validations
+    module Presence
+
+      # Ensures that essential arguments are present before request is made
+      #
+      def _validate_presence_of(*params)
+        params.each do |param|
+          raise ArgumentError, "parameter cannot be nil" if param.nil?
+        end
+      end
+
+
+      # Check if user or repository parameters are passed
+      #
+      def _validate_user_repo_params(user_name, repo_name)
+        raise ArgumentError, "[user] parameter cannot be nil" if user_name.nil?
+        raise ArgumentError, "[repo] parameter cannot be nil" if repo_name.nil?
+      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
+    extend AutoloadHelper
+
+    autoload_all 'bitbucket_rest_api/validations',
+                 :Presence => 'presence',
+                 :Token    => 'token',
+                 :Format   => 'format',
+                 :Required => 'required'
+
+    include Presence
+    include Format
+    include Token
+    include Required
+
+    VALID_API_KEYS = [
+        'page',
+        'per_page',
+        '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 = 1
+    PATCH = 0
+
+    STRING = [MAJOR, MINOR, PATCH].compact.join('.')
+  end
+end # BitBucket

data/lib/bitbucket_rest_api.rb

@@ -0,0 +1,87 @@
+# encoding: utf-8
+
+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'
+
+module BitBucket
+  extend Configuration
+
+  class << self
+
+    # Handle for the client instance
+    attr_accessor :api_client
+
+    # Alias for BitBucket::Client.new
+    #
+    # @return [BitBucket::Client]
+    def new(options = { }, &block)
+      @api_client = BitBucket::Client.new(options, &block)
+    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 AutoloadHelper
+
+    def autoload_all(prefix, options)
+      options.each do |const_name, path|
+        autoload const_name, File.join(prefix, path)
+      end
+    end
+
+    def register_constant(options)
+      options.each do |const_name, value|
+        const_set const_name.upcase.to_s, value
+      end
+    end
+
+    def lookup_constant(const_name)
+      const_get const_name.upcase.to_s
+    end
+
+  end
+
+  extend AutoloadHelper
+
+  autoload_all 'bitbucket_rest_api',
+               :API             => 'api',
+               :ApiFactory      => 'api_factory',
+               :Authorization   => 'authorization',
+               :Authorizations  => 'authorizations',
+               :Validations     => 'validations',
+               :ParameterFilter => 'parameter_filter',
+               :Normalizer      => 'normalizer',
+               :Client          => 'client',
+               :CoreExt         => 'core_ext',
+               :Request         => 'request',
+               :Response        => 'response',
+               :Result          => 'result',
+
+               :Repos           => 'repos',
+               #:Error           => 'error',
+               :Issues          => 'issues'
+  #:Teams           => 'teams',
+  #:PullRequests    => 'pull_requests',
+  #:Users           => 'users',
+  #:Events          => 'events',
+  #:Search          => 'search',
+  #:PageLinks       => 'page_links',
+  #:PageIterator    => 'page_iterator',
+  #:PagedRequest    => 'paged_request'
+
+end # BitBucket

metadata

@@ -0,0 +1,266 @@
+--- !ruby/object:Gem::Specification
+name: bitbucket_rest_api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Mike Cochran
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-07-31 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: &70165761556820 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165761556820
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: &70165761555840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165761555840
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: &70165761554920 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165761554920
+- !ruby/object:Gem::Dependency
+  name: oauth
+  requirement: &70165761554180 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165761554180
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: &70165761552500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.5.2
+  type: :runtime
+  prerelease: false
+  version_requirements: *70165761552500
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70165761551240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761551240
+- !ruby/object:Gem::Dependency
+  name: cucumber
+  requirement: &70165761550100 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761550100
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70165761548520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.8.0
+  type: :development
+  prerelease: false
+  version_requirements: *70165761548520
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70165761546980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.2.0
+  type: :development
+  prerelease: false
+  version_requirements: *70165761546980
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: &70165761545860 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.6.1
+  type: :development
+  prerelease: false
+  version_requirements: *70165761545860
+- !ruby/object:Gem::Dependency
+  name: guard
+  requirement: &70165761545080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761545080
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70165761544020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761544020
+- !ruby/object:Gem::Dependency
+  name: guard-cucumber
+  requirement: &70165761543080 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761543080
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: &70165761542340 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761542340
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: &70165761541400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70165761541400
+description: ! ' Ruby wrapper for the BitBucket API '
+email: mcochran@linux.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/bitbucket_rest_api/api/actions.rb
+- lib/bitbucket_rest_api/api.rb
+- lib/bitbucket_rest_api/api_factory.rb
+- lib/bitbucket_rest_api/authorization.rb
+- lib/bitbucket_rest_api/client.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/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/error.rb
+- lib/bitbucket_rest_api/issues/comments.rb
+- lib/bitbucket_rest_api/issues/components.rb
+- lib/bitbucket_rest_api/issues/milestones.rb
+- lib/bitbucket_rest_api/issues.rb
+- lib/bitbucket_rest_api/normalizer.rb
+- lib/bitbucket_rest_api/parameter_filter.rb
+- lib/bitbucket_rest_api/repos/changesets.rb
+- lib/bitbucket_rest_api/repos/following.rb
+- lib/bitbucket_rest_api/repos/keys.rb
+- lib/bitbucket_rest_api/repos.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.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.rb
+- lib/bitbucket_rest_api/result.rb
+- lib/bitbucket_rest_api/utils/url.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/validations.rb
+- lib/bitbucket_rest_api/version.rb
+- lib/bitbucket_rest_api.rb
+- README.md
+homepage: https://github.com/exceptionary/bitbucket
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Ruby wrapper for the BitBucket API
+test_files: []