bitbucket_rest_api 0.1.2 → 0.1.4

data/README.md

@@ -1,6 +1,8 @@
 # BitBucketAPI
 
-[Wiki](https://bitbucket.com/vongrippen/bitbucket/wiki) | [RDocs](http://rubydoc.info/github/vongrippen/bitbucket/master/frames)
+[![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.
 
@@ -32,7 +34,7 @@ At this stage you can also supply various configuration parameters, such as `:us
 bitbucket = BitBucket.new oauth_token: 'request_token', oauth_secret: 'request_secret'
 ```
 
-Alternatively, you can configure the BitBucket settings by passing a block, for instance, with custom enteprise endpoint like
+Alternatively, you can configure the BitBucket settings by passing a block:
 
 ```ruby
 bitbucket = BitBucket.new do |config|

data/lib/bitbucket_rest_api.rb

@@ -74,7 +74,10 @@ module BitBucket
 
                :Repos           => 'repos',
                #:Error           => 'error',
-               :Issues          => 'issues'
+               :Issues          => 'issues',
+               :User            => 'user',
+               :Users           => 'users'
+
   #:Teams           => 'teams',
   #:PullRequests    => 'pull_requests',
   #:Users           => 'users',

data/lib/bitbucket_rest_api/client.rb

@@ -44,9 +44,12 @@ module BitBucket
     # Many of the resources on the users API provide a shortcut for getting
     # information about the currently authenticated user.
     def users(options = {})
-      raise "Unimplemented"
-      #@users ||= ApiFactory.new 'Users', options
+      @users ||= ApiFactory.new 'Users', options
+    end
+
+    def user_api(options = {})
+      @user_api ||= ApiFactory.new 'User', options
     end
 
   end # Client
-end # BitBucket
+end # BitBucket

data/lib/bitbucket_rest_api/issues.rb

@@ -93,6 +93,23 @@ module BitBucket
 
     alias :find :get
 
+    # Delete a single issue
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.issues.delete 'user-name', 'repo-name', 'issue-id'
+    #
+    def delete(user_name, repo_name, issue_id, params={ })
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of issue_id
+
+      normalize! params
+      # _merge_mime_type(:issue, params)
+
+      delete_request("/repositories/#{user}/#{repo}/issues/#{issue_id}", params)
+    end
+
     # Create an issue
     #
     # = Inputs

data/lib/bitbucket_rest_api/repos.rb

@@ -6,9 +6,11 @@ module BitBucket
 
     # Load all the modules after initializing Repos to avoid superclass mismatch
     autoload_all 'bitbucket_rest_api/repos',
-                 :Changesets       => 'changesets',
-                 :Keys          => 'keys',
-                 :Following      => 'following'
+                 :Changesets  => 'changesets',
+                 :Keys        => 'keys',
+                 :Services    => 'services',
+                 :Following   => 'following',
+                 :Sources     => 'sources'
 
     DEFAULT_REPO_OPTIONS = {
         "website"         => "",
@@ -52,6 +54,16 @@ module BitBucket
       @following ||= ApiFactory.new 'Repos::Following'
     end
 
+    # Access to Repos::Commits API
+    def sources
+      @sources ||= ApiFactory.new 'Repos::Sources'
+    end
+
+    # Access to Repos::Services API
+    def services
+      @services ||= ApiFactory.new 'Repos::Services'
+    end
+
     # List branches
     #
     # = Examples

data/lib/bitbucket_rest_api/repos/services.rb

@@ -0,0 +1,103 @@
+# encoding: utf-8
+
+module BitBucket
+  class Repos::Services < API
+
+    REQUIRED_KEY_PARAM_NAMES = %w[ type ].freeze
+
+    # List services
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.services.list 'user-name', 'repo-name'
+    #  bitbucket.repos.services.list 'user-name', 'repo-name' { |service| ... }
+    #
+    def list(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+
+      response = get_request("/repositories/#{user}/#{repo.downcase}/services", params)
+      return response unless block_given?
+      response.each { |el| yield el }
+    end
+    alias :all :list
+
+    # Gets a single service
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.services.get 'user-name', 'repo-name', 109172378)
+    #
+    def get(user_name, repo_name, service_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of(service_id)
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
+    end
+    alias :find :get
+
+    # Create a service
+    #
+    # = Inputs
+    # * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.services.create 'user-name', 'repo-name',
+    #    "type"           => "Basecamp",
+    #    "Password"       => "...",
+    #    "Username"       => "...",
+    #    "Discussion URL" => "..."
+    #
+    def create(user_name, repo_name, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      normalize! params
+      assert_required_keys(REQUIRED_KEY_PARAM_NAMES, params)
+
+      post_request("/repositories/#{user}/#{repo.downcase}/services", params)
+    end
+
+    # Edit a service
+    #
+    # = Inputs
+    # * <tt>:type</tt> - One of the supported services. The type is a case-insensitive value.
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.repos.services.edit 'user-name', 'repo-name', 109172378,
+    #    "type"           => "Basecamp",
+    #    "Password"       => "...",
+    #    "Username"       => "...",
+    #    "Discussion URL" => "..."
+    #
+    def edit(user_name, repo_name, service_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of(service_id)
+
+      normalize! params
+
+      put_request("/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
+    end
+
+    # Delete service
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.services.delete 'user-name', 'repo-name', 109172378
+    #
+    def delete(user_name, repo_name, service_id, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of(service_id)
+      normalize! params
+
+      delete_request("/repositories/#{user}/#{repo.downcase}/services/#{service_id}", params)
+    end
+
+  end # Repos::Keys
+end # BitBucket

data/lib/bitbucket_rest_api/repos/sources.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+module BitBucket
+  class Repos::Sources < API
+
+    REQUIRED_COMMENT_PARAMS = %w[
+        body
+        changeset_id
+        line
+        path
+        position
+      ].freeze
+
+    # Gets a source of repo 
+    #
+    # = Examples
+    #  @bitbucket = BitBucket.new
+    #  @bitbucket.repos.sources.get 'user-name', 'repo-name', '6dcb09b5b57875f334f61aebed6', 'app/contorllers/')
+    #
+    def get(user_name, repo_name, sha, path, params={})
+      _update_user_repo_params(user_name, repo_name)
+      _validate_user_repo_params(user, repo) unless user? && repo?
+      _validate_presence_of sha
+      normalize! params
+
+      get_request("/repositories/#{user}/#{repo.downcase}/src/#{sha}/#{path}", params)
+    end
+    alias :find :get
+
+  end # Repos::Sources
+end # BitBucket

data/lib/bitbucket_rest_api/user.rb

@@ -0,0 +1,101 @@
+# encoding: utf-8
+
+module BitBucket
+  class User < API
+
+
+    DEFAULT_USER_OPTIONS = {
+        "first_name"      => "",
+        "last_name"       => "",
+        "avatar"          => ""
+        # TODO: can this filed be modified?
+        # "resource_uri"    => ""
+    }.freeze
+
+    # Creates new User API
+    def initialize(options = { })
+      super(options)
+    end
+
+    # Gets the basic information associated with an account and
+    # a list of all of the repositories owned by the user.
+    # See https://confluence.atlassian.com/display/BITBUCKET/user+Endpoint#userEndpoint-GETauserprofile
+    #
+    # = Examples
+    #  bitbucket = BitBucket.new
+    #  bitbucket.user_api.profile
+    #
+    def profile
+      get_request("/user")
+    end
+
+
+    # Update a user
+
+    # = Parameters
+    # * <tt>:first_name</tt>    Optional string
+    # * <tt>:last_name</tt>     Optional string
+    # * <tt>:avatar</tt>        Optional string
+    # * <tt>:resource_uri</tt>  Optional string
+    #
+    # = Examples
+    #
+    #  bitbucket = BitBucket.new
+    #  bitbucket.user_api.update :first_name => 'first-name', :last_name => 'last-name'
+    #
+
+    def update( params={ })
+      normalize! params
+      filter! DEFAULT_USER_OPTIONS, params
+
+      put_request("/user", DEFAULT_USER_OPTIONS.merge(params))
+
+    end
+
+
+    # GET a list of user privileges
+    def privileges
+      get_request("/user/privileges")
+    end
+
+
+
+    # GET a list of repositories an account follows
+    # Gets the details of the repositories that the individual or team account follows.
+    # This call returns the full data about the repositories including
+    # if the repository is a fork of another repository.
+    # An account always "follows" its own repositories.
+    def follows
+      get_request("/user/follows")
+    end
+
+
+    # GET a list of repositories visible to an account
+    # Gets the details of the repositories that the user owns
+    # or has at least read access to.
+    # Use this if you're looking for a full list of all of the repositories associated with a user.
+    def repositories
+      get_request("/user/repositories")
+    end
+
+    alias :repos :repositories
+
+
+
+    # GET a list of repositories the account is following
+    # Gets a list of the repositories the account follows.
+    # This is the same list that appears on the Following tab on your account dashboard.
+    def overview
+      get_request("/user/repositories/overview")
+    end
+
+
+
+    # GET the list of repositories on the dashboard
+    # Gets the repositories list from the account's dashboard.
+    def dashboard
+      get_request("/user/repositories/dashboard")
+    end
+
+  end # User
+end # BitBucket

data/lib/bitbucket_rest_api/users.rb

@@ -0,0 +1,24 @@
+# encoding: utf-8
+
+module BitBucket
+  class Users < API
+    extend AutoloadHelper
+
+    # Load all the modules after initializing Repos to avoid superclass mismatch
+    autoload_all 'bitbucket_rest_api/users',
+                 :Account       => 'account'
+
+
+    # Creates new Users API
+    def initialize(options = { })
+      super(options)
+    end
+
+    # Access to Users::Account API
+    def account
+      @account ||= ApiFactory.new 'Users::Account'
+    end
+
+
+  end # Users
+end # BitBucket

data/lib/bitbucket_rest_api/users/account.rb

@@ -0,0 +1,33 @@
+# encoding: utf-8
+
+module BitBucket
+  class Users::Account < API
+
+    # API about users/account , please refer to 
+    # https://confluence.atlassian.com/display/BITBUCKET/account+Resource
+    #  
+
+
+    # GET the account profile
+    # 
+    def profile(accountname)
+      response = get_request("/users/#{accountname}")
+    end
+
+    # GET the account plan
+    def plan(accountname)
+      response = get_request("/users/#{accountname}/plan")
+    end
+
+    # GET the followers
+    def followers(accountname)
+      response = get_request("/users/#{accountname}/followers")
+    end
+
+    # GET the events
+    def events(accountname)
+      response = get_request("/users/#{accountname}/events")
+    end
+
+  end # Users::Account
+end # BitBucket

data/lib/bitbucket_rest_api/version.rb

@@ -4,7 +4,7 @@ module BitBucket
   module VERSION
     MAJOR = 0
     MINOR = 1
-    PATCH = 2
+    PATCH = 4
 
     STRING = [MAJOR, MINOR, PATCH].compact.join('.')
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bitbucket_rest_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,22 +9,22 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-23 00:00:00.000000000Z
+date: 2013-08-29 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hashie
-  requirement: &70328638942480 !ruby/object:Gem::Requirement
+  requirement: &70216235124080 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.2.0
+        version: 2.0.5
   type: :runtime
   prerelease: false
-  version_requirements: *70328638942480
+  version_requirements: *70216235124080
 - !ruby/object:Gem::Dependency
   name: faraday
-  requirement: &70328638941900 !ruby/object:Gem::Requirement
+  requirement: &70216235121480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: 0.8.1
   type: :runtime
   prerelease: false
-  version_requirements: *70328638941900
+  version_requirements: *70216235121480
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70328638941380 !ruby/object:Gem::Requirement
+  requirement: &70216235110860 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -43,21 +43,21 @@ dependencies:
         version: '1.3'
   type: :runtime
   prerelease: false
-  version_requirements: *70328638941380
+  version_requirements: *70216235110860
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
-  requirement: &70328638940860 !ruby/object:Gem::Requirement
+  requirement: &70216235110340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 0.8.1
+        version: 0.9.0
   type: :runtime
   prerelease: false
-  version_requirements: *70328638940860
+  version_requirements: *70216235110340
 - !ruby/object:Gem::Dependency
   name: nokogiri
-  requirement: &70328638940400 !ruby/object:Gem::Requirement
+  requirement: &70216235109820 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -65,10 +65,10 @@ dependencies:
         version: 1.5.2
   type: :runtime
   prerelease: false
-  version_requirements: *70328638940400
+  version_requirements: *70216235109820
 - !ruby/object:Gem::Dependency
   name: simple_oauth
-  requirement: &70328638940020 !ruby/object:Gem::Requirement
+  requirement: &70216235109320 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,10 +76,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70328638940020
+  version_requirements: *70216235109320
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70328638939480 !ruby/object:Gem::Requirement
+  requirement: &70216235108660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -87,10 +87,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638939480
+  version_requirements: *70216235108660
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70328638938900 !ruby/object:Gem::Requirement
+  requirement: &70216235108040 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -98,10 +98,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638938900
+  version_requirements: *70216235108040
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70328638938340 !ruby/object:Gem::Requirement
+  requirement: &70216235107460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -109,10 +109,10 @@ dependencies:
         version: 1.8.0
   type: :development
   prerelease: false
-  version_requirements: *70328638938340
+  version_requirements: *70216235107460
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70328638937820 !ruby/object:Gem::Requirement
+  requirement: &70216235106880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -120,10 +120,10 @@ dependencies:
         version: 2.2.0
   type: :development
   prerelease: false
-  version_requirements: *70328638937820
+  version_requirements: *70216235106880
 - !ruby/object:Gem::Dependency
   name: simplecov
-  requirement: &70328638937260 !ruby/object:Gem::Requirement
+  requirement: &70216235106360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -131,10 +131,10 @@ dependencies:
         version: 0.6.1
   type: :development
   prerelease: false
-  version_requirements: *70328638937260
+  version_requirements: *70216235106360
 - !ruby/object:Gem::Dependency
   name: guard
-  requirement: &70328638936820 !ruby/object:Gem::Requirement
+  requirement: &70216235105920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -142,10 +142,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638936820
+  version_requirements: *70216235105920
 - !ruby/object:Gem::Dependency
   name: guard-rspec
-  requirement: &70328638936360 !ruby/object:Gem::Requirement
+  requirement: &70216235105360 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -153,10 +153,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638936360
+  version_requirements: *70216235105360
 - !ruby/object:Gem::Dependency
   name: guard-cucumber
-  requirement: &70328638935780 !ruby/object:Gem::Requirement
+  requirement: &70216235104840 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -164,10 +164,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638935780
+  version_requirements: *70216235104840
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70328638935360 !ruby/object:Gem::Requirement
+  requirement: &70216235104420 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -175,10 +175,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638935360
+  version_requirements: *70216235104420
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &70328638934840 !ruby/object:Gem::Requirement
+  requirement: &70216235103880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -186,7 +186,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70328638934840
+  version_requirements: *70216235103880
 description: ! ' Ruby wrapper for the BitBucket API supporting OAuth and Basic Authentication '
 email: mcochran@linux.com
 executables: []
@@ -229,6 +229,8 @@ files:
 - 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/services.rb
+- lib/bitbucket_rest_api/repos/sources.rb
 - lib/bitbucket_rest_api/repos.rb
 - lib/bitbucket_rest_api/request/basic_auth.rb
 - lib/bitbucket_rest_api/request/jsonize.rb
@@ -241,6 +243,9 @@ files:
 - lib/bitbucket_rest_api/response/xmlize.rb
 - lib/bitbucket_rest_api/response.rb
 - lib/bitbucket_rest_api/result.rb
+- lib/bitbucket_rest_api/user.rb
+- lib/bitbucket_rest_api/users/account.rb
+- lib/bitbucket_rest_api/users.rb
 - lib/bitbucket_rest_api/utils/url.rb
 - lib/bitbucket_rest_api/validations/format.rb
 - lib/bitbucket_rest_api/validations/presence.rb