bitbucket_rest_api2 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7e675e5b1e40391c9babeaf1639df858fe6ac4e05fbcad281ac15222b9c00364
+  data.tar.gz: a7d463ae7f3c48e4e95b8308d39039ce2f75558d737241ab1e6db2b1a03b40cd
+SHA512:
+  metadata.gz: 2d28542b6f044d19d3a0b8e239d906469a8e9a9ad84841a095748ffe568f2db95838af1d8673af8c5923916dc63b67e290ecf17e2c7beb8afbc5eff1509f3f12
+  data.tar.gz: c4624755aa32177de7c4707c97b4a97a71cce38b9f8dabb5ba3c8dc28433edd4a1fbb80ce5324dc8e22d72d63c9f56f6e06ae76638c0d3457bc06c9b0ee79f6e

data/LICENSE.txt

@@ -0,0 +1,7 @@
+The MIT License (MIT)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,169 @@
+# BitBucketAPI
+
+[![Gem Version](https://badge.fury.io/rb/bitbucket_rest_api.png)](http://badge.fury.io/rb/bitbucket_rest_api)
+
+[Wiki](https://github.com/vongrippen/bitbucket/wiki) | [RDocs](http://rubydoc.info/github/vongrippen/bitbucket/master/frames)
+
+A Ruby wrapper for the BitBucket REST API.
+
+## Installation
+
+Install the gem by issuing
+
+```ruby
+gem install bitbucket_rest_api
+```
+
+or put it in your Gemfile and run `bundle install`
+
+```ruby
+gem "bitbucket_rest_api"
+```
+
+## Usage
+
+Create a new client instance
+
+```ruby
+bitbucket = BitBucket.new
+```
+
+At this stage you can also supply various configuration parameters, such as `:user`,`:repo`, `:oauth_token`, `:oauth_secret`, `:basic_auth` which are used throughout the API. These can be passed directly as hash options:
+
+```ruby
+bitbucket = BitBucket.new oauth_token: 'request_token', oauth_secret: 'request_secret'
+```
+
+Alternatively, you can configure the BitBucket settings by passing a block:
+
+```ruby
+bitbucket = BitBucket.new do |config|
+  config.oauth_token   = 'request_token'
+  config.oauth_secret  = 'request_secret'
+  config.client_id     = 'consumer_key'
+  config.client_secret = 'consumer_secret'
+  config.adapter       = :net_http
+end
+```
+
+You can authenticate either using OAuth authentication or through basic authentication by passing your login and password credentials
+
+```ruby
+bitbucket = BitBucket.new login:'vongrippen', password:'...'
+```
+
+or use convenience method:
+
+```ruby
+bitbucket = BitBucket.new basic_auth: 'login:password'
+```
+
+You can interact with BitBucket interface, for example repositories, by issuing following calls that correspond directly to the BitBucket API hierarchy
+
+```ruby
+bitbucket.repos.changesets.all  'user-name', 'repo-name'
+bitbucket.repos.keys.list     'user-name', 'repo-name'
+```
+
+The response is of type [Hashie::Mash] and allows to traverse all the json response attributes like method calls.
+
+## Inputs
+
+Some API methods apart from required parameters such as username or repository name
+allow you to switch the way the data is returned to you, for instance by passing
+a block you can iterate over the list of repositories
+
+```ruby
+bitbucket.repos.list do |repo|
+    puts repo.slug
+end
+```
+
+## Advanced Configuration
+
+The `bitbucket_rest_api` gem will use the default middleware stack which is exposed by calling `stack` on client instance. However, this stack can be freely modified with methods such as `insert`, `insert_after`, `delete` and `swap`. For instance to add your `CustomMiddleware` do
+
+```ruby
+bitbucket = BitBucket.new do |config|
+  config.stack.insert_after BitBucket::Response::Helpers, CustomMiddleware
+end
+```
+
+Furthermore, you can build your entire custom stack and specify other connection options such as `adapter`
+
+```ruby
+bitbucket = BitBucket.new do |config|
+  config.adapter :excon
+
+  config.stack do |builder|
+    builder.use BitBucket::Response::Helpers
+    builder.use BitBucket::Response::Jsonize
+  end
+end
+```
+
+## API
+
+Main API methods are grouped into the following classes that can be instantiated on their own
+
+```ruby
+BitBucket         - full API access
+
+BitBucket::Repos           BitBucket::Issues
+```
+
+Some parts of BitBucket API require you to be authenticated, for instance the following are examples of APIs only for the authenticated user
+
+```ruby
+BitBucket::Issues::Create
+```
+
+You can find out supported methods by calling `actions` on a class instance in your `irb`:
+
+```ruby
+>> BitBucket::Repos.actions                 >> bitbucket.issues.actions
+---                                         ---
+|--> all                                    |--> all
+|--> branches                               |--> comments
+|--> collaborators                          |--> create
+|--> commits                                |--> edit
+|--> contribs                               |--> events
+|--> contributors                           |--> find
+|--> create                                 |--> get
+|--> downloads                              |--> labels
+|--> edit                                   |--> list
+|--> find                                   |--> list_repo
+|--> forks                                  |--> list_repository
+|--> get                                    |--> milestones
+|--> hooks                                  ...
+...
+```
+
+## Configuration
+
+Certain methods require authentication. To get your BitBucket OAuth credentials,
+register an app with BitBucket.
+
+```ruby
+BitBucket.configure do |config|
+  config.oauth_token   = YOUR_OAUTH_REQUEST_TOKEN          # Different for each user
+  config.oauth_secret  = YOUR_OAUTH_REQUEST_TOKEN_SECRET   # Different for each user
+  config.client_id     = YOUR_OAUTH_CONSUMER_TOKEN
+  config.client_secret = YOUR_OAUTH_CONSUMER_TOKEN_SECRET
+  config.basic_auth    = 'login:password'
+end
+
+or
+
+BitBucket.new(:oauth_token => YOUR_OAUTH_REQUEST_TOKEN, :oauth_secret => YOUR_OAUTH_REQUEST_TOKEN_SECRET)
+BitBucket.new(:basic_auth => 'login:password')
+```
+
+## Development
+
+Questions or problems? Please post them on the [issue tracker](https://bitbucket.com/vongrippen/bitbucket/issues). You can contribute changes by forking the project and submitting a pull request. You can ensure the tests are passing by running `bundle` and `rake`.
+
+## Copyright
+
+Copyright (c) 2012 James M Cochran.
+Original github_api gem Copyright (c) 2011-2012 Piotr Murach. See LICENSE.txt for further details.

data/lib/bitbucket_rest_api.rb

@@ -0,0 +1,90 @@
+# 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'
+
+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',
+               :User            => 'user',
+               :Users           => 'users',
+               :Invitations     => 'invitations'
+
+  #:Teams           => 'teams',
+  #:PullRequests    => 'pull_requests',
+  #:Users           => 'users',
+  #:Events          => 'events',
+  #:Search          => 'search',
+  #:PageLinks       => 'page_links',
+  #:PageIterator    => 'page_iterator',
+  #:PagedRequest    => 'paged_request'
+
+end # BitBucket

data/lib/bitbucket_rest_api/api.rb

@@ -0,0 +1,106 @@
+# -*- encoding: utf-8 -*-
+
+require 'bitbucket_rest_api/configuration'
+require 'bitbucket_rest_api/connection'
+require 'bitbucket_rest_api/validations'
+require 'bitbucket_rest_api/request'
+require 'bitbucket_rest_api/core_ext/hash'
+require 'bitbucket_rest_api/core_ext/array'
+require 'bitbucket_rest_api/api/actions'
+require 'bitbucket_rest_api/api_factory'
+
+module BitBucket
+  class API
+    include Authorization
+    include Connection
+    include Request
+
+    # TODO consider these optional in a stack
+    include Validations
+    include ParameterFilter
+    include Normalizer
+
+    attr_reader *Configuration::VALID_OPTIONS_KEYS
+
+    attr_accessor *VALID_API_KEYS
+
+    # Callback to update global configuration options
+    class_eval do
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        define_method "#{key}=" do |arg|
+          self.instance_variable_set("@#{key}", arg)
+          BitBucket.send("#{key}=", arg)
+        end
+      end
+    end
+
+    # Creates new API
+    def initialize(options={}, &block)
+      super()
+      setup options
+      set_api_client
+
+      self.instance_eval(&block) if block_given?
+    end
+
+    def setup(options={})
+      options = BitBucket.options.merge(options)
+      Configuration::VALID_OPTIONS_KEYS.each do |key|
+        send("#{key}=", options[key])
+      end
+      process_basic_auth(options[:basic_auth])
+    end
+
+    # Extract login and password from basic_auth parameter
+    def process_basic_auth(auth)
+      case auth
+      when String
+        self.login, self.password = auth.split(':', 2)
+      when Hash
+        self.login    = auth[:login]
+        self.password = auth[:password]
+      end
+    end
+
+    # Assigns current api class
+    def set_api_client
+      BitBucket.api_client = self
+    end
+
+    # Responds to attribute query or attribute clear
+    def method_missing(method, *args, &block) # :nodoc:
+      case method.to_s
+      when /^(.*)\?$/
+        return !self.send($1.to_s).nil?
+      when /^clear_(.*)$/
+        self.send("#{$1.to_s}=", nil)
+      else
+        super
+      end
+    end
+
+    def update_and_validate_user_repo_params(user_name, repo_name=nil)
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+    end
+
+    def _update_user_repo_params(user_name, repo_name=nil) # :nodoc:
+      self.user = user_name || self.user
+      self.repo = repo_name || self.repo
+    end
+
+    def _merge_user_into_params!(params)  #  :nodoc:
+      params.merge!({ 'user' => self.user }) if user?
+    end
+
+    def _merge_user_repo_into_params!(params)   #  :nodoc:
+      { 'user' => self.user, 'repo' => self.repo }.merge!(params)
+    end
+
+    def _merge_mime_type(resource, params) # :nodoc:
+                                           #       params['resource'] = resource
+                                           #       params['mime_type'] = params['mime_type'] || :raw
+    end
+
+  end # API
+end # BitBucket

data/lib/bitbucket_rest_api/api/actions.rb

@@ -0,0 +1,35 @@
+# encoding: utf-8
+
+module BitBucket
+  class API
+
+    # Returns all API public methods for a given class.
+    def self.inherited(klass)
+      klass.class_eval <<-RUBY_EVAL, __FILE__, __LINE__ + 1
+        def self.actions
+          self.new.api_methods_in(#{klass})
+        end
+        def actions
+          api_methods_in(#{klass})
+        end
+      RUBY_EVAL
+      super
+    end
+
+    def api_methods_in(klass)
+      methods = []
+      (klass.send(:instance_methods, false) - ['actions']).sort.each do |method|
+        methods << method
+      end
+      klass.included_modules.each do |mod|
+        if mod.to_s =~ /#{klass}/
+          mod.instance_methods(false).each do |met|
+            methods << met
+          end
+        end
+      end
+      methods
+    end
+
+  end # API
+end # BitBucket

data/lib/bitbucket_rest_api/api_factory.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+require 'bitbucket_rest_api/core_ext/hash'
+
+module BitBucket
+  class ApiFactory
+
+    # Instantiates a new bitbucket api object
+    def self.new(klass, options={})
+      return create_instance(klass, options) if klass
+      raise ArgumentError, 'must provide klass to be instantiated'
+    end
+
+    # Passes configuration options to instantiated class
+    def self.create_instance(klass, options)
+      options.symbolize_keys!
+      instance = convert_to_constant(klass.to_s).new options
+      BitBucket.api_client = instance
+      instance
+    end
+
+    def self.convert_to_constant(classes)
+      constant = BitBucket
+      classes.split('::').each do |klass|
+        constant = constant.const_get klass
+      end
+      return constant
+    end
+  end
+end # BitBucket