tinybucket 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9d596d1229598dd3fc84210c64d68b7e2f133986
-  data.tar.gz: 1c9b5eeced1f04ec09f0be85ffa07306f6ee60ef
+  metadata.gz: 7c36e731063e026b4a9765820e9c2af76d614b37
+  data.tar.gz: 6c751c8bde9a75fd7bb43b82e25f9f291c711e5f
 SHA512:
-  metadata.gz: 09ee886f336681f0b0b9e0b734899334b4589ce28cd8dc43989a726d0afca94bc9ede953e413c3887e450836d79169eefc4aab82df587210c749bf9cb1ec3fca
-  data.tar.gz: 29a5525a8133c69414e3e7023d6c73213979bdad3544b4b0fc3b4a121a1f597a9f697ef001affbed0c668817c3804898e5ff5898a13357c6915e46a1e30975ff
+  metadata.gz: 932cbe0ffb529644bd277f0efe6d9e8fba47b37069aa3eb9ed8cf9c1b744717ebde8f6ed844e4c1ce55a5154829216365b137afffc52a30781ba02f9c3edb20c
+  data.tar.gz: 3145f50edc5ca01591945a5055ad14059afab8be2909f1d16213f23ea7dc35357d477d68b8c1fa7bb0e99ffff7f5ca26aa1a37e3be45a72b9c58a61723d78127

data/.gitignore

@@ -22,11 +22,6 @@ features
 /pkg/
 /tmp/
 
-## Specific to RubyMotion:
-.dat*
-.repl_history
-build/
-
 ## Documentation cache and generated files:
 /.yardoc/
 /_yardoc/

data/README.md

@@ -134,6 +134,17 @@ repos  = bucket.repos('someone')
 
 ##### repository Resource
 
+###### Collection Methods
+
+```ruby
+repos = bucket.repos('myname')
+
+# [ ] POST a new repository
+repos.create(params)
+```
+
+###### Object Methods
+
 ```ruby
 # [x] GET a repository
 repo = bucket.repo('someone', 'great_repo')
@@ -142,11 +153,8 @@ repo = bucket.repo('someone', 'great_repo')
 # (Load the repository attributes from Bitbucket WebAPI)
 repo.load
 
-# [ ] POST a new repository
-    repo.create(params)
-
 # [ ] DELETE a repository
-    repo.destroy
+repo.destroy
 
 # [x] GET a list of watchers
 watchers = repo.watchers
@@ -157,44 +165,52 @@ repos = repo.forks
 
 ##### pullrequests Resource
 
+###### Collection Methods
+
 ```ruby
 repo = bucket.repo('someone', 'great_repo')
 
-# [x] GET a list of open pull requests
+# [x ] GET a list of pull requests
 pull_requests = repo.pull_requests(options)
 
-# [x] GET a specific pull request
-pull_request   = repo.pull_request(pr_id)
-
 # [ ] POST (create) a new pull request
-     repo.pull_request.create(params)
+pull_requests.create(params)
+
+# [ ] GET the log of all of a repository's pull request activity
+activities = pull_requests.activities(options)
+```
+
+###### Object Methods
+
+```ruby
+repo = bucket.repo('someone', 'great_repo')
+
+# [x] GET a specific pull request
+pull_request = repo.pull_request(pr_id)
 
 # [ ] PUT a pull request update
-     repo.pull_request(pr_id).update(params)
+pull_request.update(params)
 
 # [x] GET the commits for a pull request
 commits = pull_request.commits
 
 # [x] POST a pull request approval
-          pull_request.approve
+pull_request.approve
 
 # [x] DELETE a pull request approval
-          pull_request.unapprove
+pull_request.unapprove
 
 # [x] GET the diff for a pull request
 diff = pull_request.diff
 
-# [ ] GET the log of all of a repository's pull request activity
-activities = repo.pull_requests_activities(options) # TODO: fix method name.
-
 # [ ] GET the activity for a pull request
 activities = pull_request.activities(options)
 
 # [x] Accept and merge a pull request
-             pull_request.merge(options)
+pull_request.merge(options)
 
 # [x] Decline or reject a pull request
-             pull_request.decline(options)
+pull_request.decline(options)
 
 # [x] GET a list of pull request comments
 comments = pull_request.comments
@@ -205,12 +221,20 @@ comment = pull_request.comment(comment_id)
 
 ##### commits or commit Resource
 
+###### Collection Methods
+
 ```ruby
 repo = bucket.repo('someone', 'great_repo')
 
 # [x] GET a commits list for a repository or compare commits across branches
 # branchortag, include, exclude options
 commits = repo.commits(options)
+```
+
+###### Object Methods
+
+```ruby
+repo = bucket.repo('someone', 'great_repo')
 
 # [x] GET an individual commit
 commit = repo.commit('revision')
@@ -222,37 +246,45 @@ comments = commit.comments
 comment = commit.comment(comment_id)
 
 # [x] POST a commit approval
-  commit.approve
+commit.approve
 
 # [x] DELETE a commit approval
-  commit.unapprove
+commit.unapprove
 ```
 
 ##### branch-restrictions Resource
 
+###### Collection Methods
+
 ```ruby
-repo = bucket.repo('someone', 'great_repo').find
+repo = bucket.repo('someone', 'great_repo')
 
 # [x] GET the branch-restrictions
 restrictions = repo.branch_restrictions
 
 # [ ] POST the branch-restrictions
-  repo.create_branch_restrictions(restrictions)
+new_restriction = restrictions.create(params)
+```
+
+###### Object Methods
+
+```ruby
+repo = bucket.repo('someone', 'great_repo').find
 
 # [x] GET a specific restriction
 restriction = repo.branch_restriction(restriction_id)
 
 # [ ] PUT a branch restriction update
-  restriction.update(params)
+restriction.update(params)
 
 # [ ] DELETE the branch restriction
-  restriction.destroy
+restriction.destroy
 ```
 
 ##### diff Resource
 
 ```ruby
-repo = bucket.repo('someone', 'great_repo').find
+repo = bucket.repo('someone', 'great_repo')
 COMMIT_ID = '7e968c5'
 
 # [x] GET a diff
@@ -262,6 +294,50 @@ diff = repo.diff(COMMIT_ID)
 patch = repo.patch(COMMIT_ID)
 ```
 
+##### statuses/build Resource
+
+###### Collection Methods
+
+```ruby
+repo = bucket.repo('someone', 'great_repo')
+
+COMMIT_ID = '7e968c5'
+commit = repo.commit(COMMIT_ID)
+
+BUILD_STATUS_KEY = 'tinybucket'
+
+# [x] POST a build status for a commit
+commit.build_statuses.create(
+  key: BUILD_STATUS_KEY,
+  state: 'INPROGRESS',
+  name: 'Name of build',
+  url: 'link to the build result',
+  description: 'about build'
+)
+```
+
+###### Object Methods
+
+```
+repo = bucket.repo('someone', 'great_repo')
+
+COMMIT_ID = '7e968c5'
+commit = repo.commit(COMMIT_ID)
+
+BUILD_STATUS_KEY = 'tinybucket'
+
+# [x] GET the build status for a commit
+status = commit.build_status(BUILD_STATUS_KEY)
+
+# [x] PUT a build status for a commit
+status.update(
+  state: 'SUCCESSFUL',
+  name: 'Name of build',
+  url: 'link to the build result',
+  description: 'about build'
+)
+```
+
 ## Contribution
 
 1. Fork it ( https://github.com/[my-github-username]/bitbucket/fork )

data/lib/tinybucket.rb

@@ -31,6 +31,7 @@ require 'tinybucket/model/concerns'
 require 'tinybucket/model'
 require 'tinybucket/parser'
 require 'tinybucket/request'
+require 'tinybucket/resource'
 require 'tinybucket/response'
 
 require 'tinybucket/client'

data/lib/tinybucket/api.rb

@@ -5,6 +5,7 @@ module Tinybucket
     [
       :BaseApi,
       :BranchRestrictionsApi,
+      :BuildStatusApi,
       :CommitsApi,
       :CommentsApi,
       :DiffApi,

data/lib/tinybucket/api/build_status_api.rb

@@ -0,0 +1,55 @@
+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 :repo_owner, :repo_slug
+
+      # 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,
+          Tinybucket::Parser::BuildStatusParser
+        )
+      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),
+          Tinybucket::Parser::BuildStatusParser
+        )
+      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,
+          Tinybucket::Parser::BuildStatusParser
+        )
+      end
+    end
+  end
+end

data/lib/tinybucket/api/helper.rb

@@ -6,6 +6,7 @@ module Tinybucket
       [
         :ApiHelper,
         :BranchRestrictionsHelper,
+        :BuildStatusHelper,
         :CommitsHelper,
         :CommentsHelper,
         :DiffHelper,

data/lib/tinybucket/api/helper/build_status_helper.rb

@@ -0,0 +1,35 @@
+module Tinybucket
+  module Api
+    module Helper
+      module BuildStatusHelper
+        include ::Tinybucket::Api::Helper::ApiHelper
+
+        private
+
+        def path_to_find(revision, key)
+          build_path(base_path(revision),
+                     [key, 'key'])
+        end
+
+        def path_to_post(revision)
+          base_path(revision)
+        end
+
+        def path_to_put(revision, key)
+          build_path(base_path(revision),
+                     [key, 'key'])
+        end
+
+        def base_path(revision)
+          build_path('/repositories',
+                     [repo_owner, 'repo_owner'],
+                     [repo_slug,  'repo_slug'],
+                     'commit',
+                     [revision, 'revision'],
+                     'statuses',
+                     'build')
+        end
+      end
+    end
+  end
+end

data/lib/tinybucket/client.rb

@@ -17,23 +17,22 @@ module Tinybucket
     # @overload repos(options)
     #   get public repositories.
     #   @option options [Hash] a hash with options
-    # @return [Tinybucket::Enumerator] enumerator to enumerate repositories
-    #   as [Tinybucket::Model::Repository]
+    # @return [Tinybucket::Resource::Repos] repository resource
     def repos(*args)
       case args.size
       when 0
-        public_repos(*args)
+        public_repos
       when 1
         case args.first
         when Hash
-          public_repos(*args)
+          public_repos(args.first)
         when String, Symbol
-          owners_repos(*args)
+          owners_repos(args.first)
         else
           raise ArgumentError
         end
       when 2
-        owners_repos(*args)
+        owners_repos(args[0], args[1])
       else
         raise ArgumentError
       end
@@ -46,10 +45,10 @@ module Tinybucket
     #     repo_slug})
     # @return [Tinybucket::Model::Repository]
     def repo(owner, repo_slug)
-      m = Tinybucket::Model::Repository.new({})
-      m.repo_owner = owner
-      m.repo_slug = repo_slug
-      m
+      Tinybucket::Model::Repository.new({}).tap do |m|
+        m.repo_owner = owner
+        m.repo_slug = repo_slug
+      end
     end
 
     # Get the team
@@ -57,9 +56,9 @@ module Tinybucket
     # @param teamname [String] the team name.
     # @return [Tinybucket::Model::Team]
     def team(teamname)
-      m = Tinybucket::Model::Team.new({})
-      m.username = teamname
-      m
+      Tinybucket::Model::Team.new({}).tap do |m|
+        m.username = teamname
+      end
     end
 
     # Get the user profile
@@ -67,48 +66,32 @@ module Tinybucket
     # @param username [String] the user name.
     # @return [Tinybucket::Model::Profile]
     def user(username)
-      m = Tinybucket::Model::Profile.new({})
-      m.username = username
-      m
+      Tinybucket::Model::Profile.new({}).tap do |m|
+        m.username = username
+      end
     end
 
     private
 
-    def public_repos(*args)
-      options = args.empty? ? {} : args.first
+    # Get public repositories
+    #
+    # @param options [Hash]
+    # @return [Tinybucket::Resource::Repos]
+    def public_repos(options = {})
       raise ArgumentError unless options.is_a?(Hash)
 
-      enumerator(
-        repos_api,
-        :list,
-        options
-      )
+      Tinybucket::Resource::Repos.new(nil, options)
     end
 
-    def owners_repos(*args)
-      owner = args.first
-      options = (args.size == 2) ? args[1] : {}
+    # Get Owner's repositories
+    #
+    # @param owner [String]
+    # @param options [Hash]
+    # @return [Tinybucket::Resource::Repos]
+    def owners_repos(owner, options = {})
       raise ArgumentError unless options.is_a?(Hash)
 
-      enumerator(
-        user_api(owner),
-        :repos,
-        options
-      )
-    end
-
-    def repos_api
-      create_instance('Repos')
-    end
-
-    def user_api(owner)
-      api = create_instance('User')
-      api.username = owner
-      api
-    end
-
-    def create_instance(name)
-      ApiFactory.create_instance(name)
+      Tinybucket::Resource::Repos.new(owner, options)
     end
   end
 end