stash_core_api 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 92dde081a8989016a1f691b15c6583a5dcf7e53c
-  data.tar.gz: 7176dcc1f42ead488c88c3a14742d027c03ae396
+SHA256:
+  metadata.gz: eefa96b5608f5e886bec64e6bbecad120094e799c74c9e8c324ed58314174836
+  data.tar.gz: 729a6906231d22ccefbd8b7573eb64e8a08a7c08a7f2d20198bcb9c667813b08
 SHA512:
-  metadata.gz: 19106b18a6ff58aee5af85949b7ec5ad4ff58bf82b5147060e61d2b6519d80c4aff2c247b5f7338e939104787f124e93c18b762812d76bb841b7af7983b88629
-  data.tar.gz: d119a2e94eceb9c28c806d8a4510b4079d6ee913bff34b29e3e445e5b519491a8e373fbc9192314329db334bdbecd935fcce85b342125865e9c10cfe416a4312
+  metadata.gz: b0c1cff131d164f24fb2e5b863385f1862e329cdac4f06ce89e5f80f3dcf23c879b1d75777c3869fc05048c622f42af34fb26f7ed582953b3ae48fa2ab2d557d
+  data.tar.gz: 2effd106f6e9b8ea1623f524568d6f77dffa18b1af8756140f58a0774e6c54b97ffa9377965b6f6c075979169761917d81e9ca944d6f283ebccff78d807139b0

data/lib/stash_core_api/api.rb

@@ -1,5 +1,6 @@
 require 'stash_core_api/commits'
 require 'stash_core_api/pull_requests'
+require 'stash_core_api/compare'
 
 module StashCoreAPI
   # All methods have been separated into modules and
@@ -7,4 +8,5 @@ module StashCoreAPI
   # https://developer.atlassian.com/static/rest/stash/3.9.2/stash-rest.html.
   include StashCoreAPI::Commits
   include StashCoreAPI::PullRequests
+  include StashCoreAPI::Compare
 end

data/lib/stash_core_api/commits.rb

@@ -30,5 +30,15 @@ module StashCoreAPI
       end
       perform_get(endpoint)
     end
+
+    # @see https://docs.atlassian.com/DAC/rest/stash/3.9.2/stash-rest.html#idp1729008
+    #
+    # @param limit [Integer] the maximum number of commits to return
+    #   Stash defaults to 25
+    def commit_changes(commit_id, limit: nil)
+      endpoint = "/commits/#{commit_id}/changes"
+      endpoint = "#{endpoint}?limit=#{limit}" if limit
+      perform_get(endpoint)
+    end
   end
 end

data/lib/stash_core_api/compare.rb

@@ -0,0 +1,29 @@
+require 'stash_core_api/utils'
+
+module StashCoreAPI
+  # Interfaces with compare endpoints of Stash CoreAPI API
+  module Compare
+    include StashCoreAPI::Utils
+
+    # @see https://docs.atlassian.com/DAC/rest/stash/3.9.2/stash-rest.html#idp3045184
+    #
+    # @param from [String] the source commit (can be a partial/full changeset
+    #   id or qualified/unqualified ref name)
+    # @param to [String] the target commit (can be a partial/full changeset
+    #   id or qualified/unqualified ref name)
+    # @param fromRepo [String] an optional parameter specifying the source
+    #   repository containing the source changeset if that changeset is not
+    #   present in the current repository; the repository can be specified
+    #   by either its ID fromRepo=42 or by its project key plus its repo slug
+    #   separated by a slash: fromRepo=projectKey/repoSlug
+    # @param limit [Integer] the maximum number of commits to return
+    #   Stash defaults to 25
+    def compare_changes(from_commit, to_commit, from_repo: nil, limit: nil)
+      endpoint = "/compare/changes?from=#{from_commit}&to=#{to_commit}"
+      endpoint = "#{endpoint}&fromRepo=#{from_repo}" if from_repo
+      endpoint = "#{endpoint}&limit=#{limit}" if limit
+      perform_get(endpoint)
+    end
+  end
+end
+

data/lib/stash_core_api/version.rb

@@ -2,5 +2,5 @@
 
 # StashCoreAPI module
 module StashCoreAPI
-  VERSION = '0.1.5'
+  VERSION = '0.1.6'
 end

data/spec/fixtures/commit_changes_bad_sha.json

@@ -0,0 +1,2 @@
+{"errors":[{"context":null,"message":"Commit \"083f66ba3c6\" does not exist in this repository","exceptionName":"com.atlassian.bitbucket.NoSuchObjectException"}]}
+

data/spec/fixtures/compare_changes_bad_range.json

@@ -0,0 +1 @@
+{"errors":[{"context":null,"message":"Object \"c\" does not exist in this repository","exceptionName":"com.atlassian.bitbucket.NoSuchObjectException"}]}

data/spec/stash_core_api/commits_spec.rb

@@ -59,4 +59,24 @@ RSpec.describe StashCoreAPI::Client do
       end
     end
   end
+
+  describe '#commit_changes' do
+    it 'should hit the approprate stash api with the given options' do
+      endpoint = "/commits/083f66ba3c6/changes?limit=1"
+      expect(client).to receive(:perform_get).with(endpoint)
+      client.commit_changes('083f66ba3c6', limit: 1)
+    end
+
+    it 'should raise an error when the commit is not valid' do
+      endpoint = "/#{base_path(client)}/commits/083f66ba3c6/changes"
+      stub_get(client, endpoint).to_return(
+        status: 404,
+        body: fixture('commit_changes_bad_sha.json'),
+        headers: { 'Content-Type' => 'application/json' }
+      )
+      expect { client.commit_changes('083f66ba3c6') }.to raise_error(
+        StashCoreAPI::Error::NotFound, 'Commit "083f66ba3c6" does not exist in this repository'
+      )
+    end
+  end
 end

data/spec/stash_core_api/compare_spec.rb

@@ -0,0 +1,36 @@
+require 'spec_helper'
+
+RSpec.describe StashCoreAPI::Client do
+  let(:client) do
+    StashCoreAPI::Client.new(
+      user: 'user',
+      pass: 'pass',
+      project: 'project',
+      repository: 'repository',
+      stash_url: 'https://stash.com',
+    )
+  end
+
+  describe '#compare' do
+    describe '#changes' do
+      it 'should hit the approprate stash api with the given options' do
+        endpoint = "/compare/changes?from=a&to=b&fromRepo=c&limit=1"
+        expect(client).to receive(:perform_get).with(endpoint)
+        changes = client.compare_changes('a', 'b', from_repo: 'c', limit: 1)
+      end
+
+      it 'should raise an error when the range is not valid' do
+        endpoint = "/#{base_path(client)}/compare/changes?from=c&to=d"
+        stub_get(client, endpoint).to_return(
+          status: 404,
+          body: fixture('compare_changes_bad_range.json'),
+          headers: { 'Content-Type' => 'application/json' }
+        )
+        expect { client.compare_changes('c', 'd') }.to raise_error(
+          StashCoreAPI::Error::NotFound, 'Object "c" does not exist in this repository'
+        )
+      end
+    end
+  end
+end
+

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: stash_core_api
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Alyssa Pohahau
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-01-11 00:00:00.000000000 Z
+date: 2019-04-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http
@@ -113,6 +113,7 @@ files:
 - lib/stash_core_api/api.rb
 - lib/stash_core_api/client.rb
 - lib/stash_core_api/commits.rb
+- lib/stash_core_api/compare.rb
 - lib/stash_core_api/error.rb
 - lib/stash_core_api/pull_requests.rb
 - lib/stash_core_api/request.rb
@@ -120,14 +121,17 @@ files:
 - lib/stash_core_api/version.rb
 - spec/fixtures/can_merge.json
 - spec/fixtures/cannot_merge.json
+- spec/fixtures/commit_changes_bad_sha.json
 - spec/fixtures/commits.json
 - spec/fixtures/commits_with_limit.json
 - spec/fixtures/commits_with_with_count.json
+- spec/fixtures/compare_changes_bad_range.json
 - spec/fixtures/info.json
 - spec/fixtures/unauthorized_error.json
 - spec/spec_helper.rb
 - spec/stash_core_api/client_spec.rb
 - spec/stash_core_api/commits_spec.rb
+- spec/stash_core_api/compare_spec.rb
 - spec/stash_core_api/error_spec.rb
 - spec/stash_core_api/pull_requests_spec.rb
 - spec/stash_core_api/request_spec.rb
@@ -152,22 +156,24 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.12
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Atlassian Stash Core REST API Client
 test_files:
 - spec/fixtures/can_merge.json
 - spec/fixtures/cannot_merge.json
+- spec/fixtures/commit_changes_bad_sha.json
 - spec/fixtures/commits.json
 - spec/fixtures/commits_with_limit.json
 - spec/fixtures/commits_with_with_count.json
+- spec/fixtures/compare_changes_bad_range.json
 - spec/fixtures/info.json
 - spec/fixtures/unauthorized_error.json
 - spec/spec_helper.rb
 - spec/stash_core_api/client_spec.rb
 - spec/stash_core_api/commits_spec.rb
+- spec/stash_core_api/compare_spec.rb
 - spec/stash_core_api/error_spec.rb
 - spec/stash_core_api/pull_requests_spec.rb
 - spec/stash_core_api/request_spec.rb