universal-git-client 1.2.4

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 8b4c37347ad2d272fb542744b0f095e9901b45d5a422eb0ef13eba7144377a2a
+  data.tar.gz: a6e42628553bbe0674131e8d90f270e2e91d52aa8048dd7a374abd2d368df3a4
+SHA512:
+  metadata.gz: 45d3c7fde797319a54f5b05e79b9993ce17ebb3305ee6145f898c70e375edd9952b302e7efacdecf27befa97ce2712e8af1a2cc0eaf596efab43cc2e2d698d01
+  data.tar.gz: 461a1270d635a7a15a96a3912313d8377220c1e58cc4879d4afd2ef48a4a22cf6232eea81e511ac06aecb2de8a3d1dbb447bbe755384f1fab66c88e8eab53d44

data/LICENSE

@@ -0,0 +1,22 @@
+The MIT License
+
+Copyright (c) SmartBear
+
+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,40 @@
+# README
+
+## Steps to release a new version of universal-git-client gem
+
+1- Push the new code on Github repository
+
+2- Execute the rake task `rake version:bump:[type]` with type: <major|minor|patch>
+
+3- Execute the rake task `rake gemspec:release` It will regenerate, validate gemspec then commit and push to git
+
+4- Go to the universal-git-client repository on Github, from the "Code" tab, click on "N releases" (N: releases count), click on "Draft a new release" and fill the form:
+
+- Tag version: version number, for example v0.4.0
+- Release title: version number, for example v0.4.0
+- Write: release notes
+
+To validate, click on "Publish release" and it's done :)
+
+## Contributing to universal-git-client
+ 
+* Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet.
+* Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it.
+* Fork the project.
+* Start a feature/bugfix branch.
+* Commit and push until you are happy with your contribution.
+* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
+* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
+
+## Usage
+ * To start the comand line interpreter : `pry -I ./lib -r universal-git-client` 
+ 
+ * To create a client object : `client = UniversalGitClient.factory.build(provider, base_url, access_token)`  
+The _base_url_ parameter must be the url to the API of your provider.
+
+ * _Example_: ```client = UniversalGitClient.factory.build(:bitbucket_server, base_url: "http://bitbucket.ngrok.io/rest/api/1.0", access_token: "123456789")```
+
+
+## Copyright
+
+Copyright (c) 2019 SmartBear - HipTest

data/VERSION

@@ -0,0 +1 @@
+1.2.4

data/lib/universal-git-client.rb

@@ -0,0 +1,18 @@
+require 'universal-git-client/configuration'
+require 'universal-git-client/client_factory'
+
+module UniversalGitClient
+  class << self
+    def configure
+      yield Configuration.config
+    end
+
+    def config
+      Configuration.config
+    end
+
+    def factory
+      ClientFactory
+    end
+  end
+end

data/lib/universal-git-client/client.rb

@@ -0,0 +1,72 @@
+require 'universal-git-client/normalizers/github'
+require 'universal-git-client/normalizers/gitlab'
+require 'universal-git-client/normalizers/bitbucket'
+require 'universal-git-client/normalizers/bitbucket_server'
+
+
+module UniversalGitClient
+  class Client
+    attr_reader :provider, :http_client
+
+    def initialize(provider, http_client)
+      @provider = provider
+      @http_client = http_client
+    end
+
+    def user
+      response = http_client.user
+      normalize(response, :User)
+    end
+
+    def organizations(*args)
+      response = http_client.organizations(*args)
+      normalize(response, :Organization)
+    end
+
+    def user_repos(*args)
+      response = http_client.user_repos(*args)
+      normalize(response, :Repository)
+    end
+
+    def orga_repos(*args)
+      response = http_client.orga_repos(*args)
+      normalize(response, :Repository)
+    end
+
+    def repository(*args)
+      response = http_client.repository(*args)
+      normalize(response, :Repository)
+    end
+
+    def branches(*args)
+      response = http_client.branches(*args)
+      normalize(response, :Branch)
+    end
+
+    def branch(*args)
+      response = http_client.branch(*args)
+      normalize(response, :Branch)
+    end
+
+    def download_repo_archive(*args)
+      http_client.download_repo_archive(*args)
+    end
+
+    def setup_repo_webhook(*args)
+      response = http_client.setup_repo_webhook(*args)
+      normalize(response, :Webhook)
+    end
+
+    def delete_repo_webhook(*args)
+      http_client.delete_repo_webhook(*args)
+    end
+
+    private
+
+    def normalize(response, resource)
+      normalizer = UniversalGitClient.const_get("Normalizers::#{http_client.class.name.demodulize}")
+      normalized = normalizer.new(response, resource).normalize
+      normalized.serializable_hash
+    end
+  end
+end

data/lib/universal-git-client/client_factory.rb

@@ -0,0 +1,26 @@
+require 'universal-git-client/client'
+require 'universal-git-client/http/github'
+require 'universal-git-client/http/gitlab'
+require 'universal-git-client/http/bitbucket'
+require 'universal-git-client/http/bitbucket_server'
+
+module UniversalGitClient
+  class ClientFactory
+    class << self
+      def build(provider, *args)
+        case provider
+        when :github
+          Client.new('GitHub', UniversalGitClient::Http::Github.new(*args))
+        when :gitlab
+          Client.new('GitLab', UniversalGitClient::Http::Gitlab.new(*args))
+        when :bitbucket
+          Client.new('Bitbucket', UniversalGitClient::Http::Bitbucket.new(*args))
+        when :bitbucket_server
+          Client.new('Bitbucket Server', UniversalGitClient::Http::BitbucketServer.new(*args))
+        else
+          raise ArgumentError, 'Unknown provider'
+        end
+      end
+    end
+  end
+end

data/lib/universal-git-client/configuration.rb

@@ -0,0 +1,13 @@
+require 'dry-configurable'
+
+module UniversalGitClient
+  class Configuration
+    extend Dry::Configurable
+
+    setting :logger
+    setting :log_level, :debug
+    setting :log_format, :apache
+    setting :user_agent, 'UniversalGitClient-Ruby'
+    setting :default_pagination, 30
+  end
+end

data/lib/universal-git-client/errors.rb

@@ -0,0 +1,29 @@
+module UniversalGitClient
+  module Errors
+    class HttpError < StandardError
+      attr_reader :response
+
+      def initialize(msg, response)
+        @response = response
+        super(msg)
+      end
+    end
+
+    class ClientError < HttpError; end
+    class ServerError < HttpError; end
+
+    class BadRequest < ClientError; end
+    class Unauthorized < ClientError; end
+    class Forbidden < ClientError; end
+    class NotFound < ClientError; end
+    class MethodNotAllowed < ClientError; end
+    class NotAcceptable < ClientError; end
+    class Conflict < ClientError; end
+    class UnsupportedMediaType < ClientError; end
+    class UnprocessableEntity < ClientError; end
+
+    class InternalServerError < ServerError; end
+    class BadGateway < ServerError; end
+    class ServiceUnavailable < ServerError; end
+  end
+end

data/lib/universal-git-client/http/base.rb

@@ -0,0 +1,69 @@
+require 'universal-git-client/http/response_validation'
+require 'httparty'
+require 'down'
+require 'deep_merge'
+
+module UniversalGitClient
+  module Http
+    class Base
+      include HTTParty
+      include ResponseValidation
+
+      def initialize(base_url:, download_url: nil, access_token: nil, private_token: nil)
+        if access_token && private_token
+          raise ArgumentError, 'access_token and private_token params are mutually exclusive'
+        end
+
+        @base_url = base_url.chomp('/')
+        @download_url = download_url
+        @access_token = access_token
+        @private_token = private_token
+      end
+
+      private
+
+      attr_reader :base_url, :download_url, :access_token, :private_token
+
+      def user_agent
+        UniversalGitClient.config.user_agent
+      end
+
+      def default_elements_per_page
+        UniversalGitClient.config.default_pagination
+      end
+
+      def logger
+        UniversalGitClient.config.logger
+      end
+
+      def log_level
+        UniversalGitClient.config.log_level
+      end
+
+      def log_format
+        UniversalGitClient.config.log_format
+      end
+
+      def default_options
+        {
+          logger: logger,
+          log_level: log_level,
+          log_format: log_format,
+          base_uri: base_url,
+          headers: {
+            'Accept' => 'application/json',
+            'Content-Type' => 'application/json',
+            'Authorization' => (access_token ? "Bearer #{access_token}" : nil),
+            'Private-Token' => private_token,
+            'User-Agent' => user_agent,
+          }.compact,
+        }
+      end
+
+      def down_default_options
+        options = default_options[:headers].reject { |k, _v| %w[Accept Content-Type].include?(k) }
+        options.reject { |k, _v| [:base_uri, :logger, :log_level, :log_format].include?(k) }
+      end
+    end
+  end
+end

data/lib/universal-git-client/http/bitbucket.rb

@@ -0,0 +1,118 @@
+require 'universal-git-client/http/base'
+require 'uri'
+
+module UniversalGitClient
+  module Http
+    class Bitbucket < Base
+      def user
+        with_response_validation! do
+          self.class.get('/user', default_options)
+        end
+      end
+
+      def organizations(page: 1, per_page: nil)
+        with_response_validation! do
+          self.class.get(
+            '/teams',
+            default_options.merge(
+              query: {
+                role: 'member',
+                page: page,
+                pagelen: per_page || default_elements_per_page,
+              },
+            )
+          )
+        end
+      end
+
+      def user_repos(page: 1, per_page: nil)
+        current_user_uuid = URI.encode_www_form_component(self.user['uuid'])
+        with_response_validation! do
+          self.class.get(
+            "/repositories/#{current_user_uuid}",
+            default_options.merge(
+              query: {
+                page: page,
+                pagelen: per_page || default_elements_per_page,
+              },
+            )
+          )
+        end
+      end
+
+      def orga_repos(organization:, page: 1, per_page: nil)
+        with_response_validation! do
+          self.class.get(
+            "/repositories/#{organization}",
+            default_options.merge(
+              query: {
+                page: page,
+                pagelen: per_page || default_elements_per_page,
+              },
+            )
+          )
+        end
+      end
+
+      def repository(owner:, repo:)
+        with_response_validation! do
+          self.class.get("/repositories/#{owner}/#{repo}", default_options)
+        end
+      end
+
+      def branches(owner:, repo:, page: 1, per_page: nil)
+        with_response_validation! do
+          self.class.get(
+            "/repositories/#{owner}/#{repo}/refs/branches",
+            default_options.merge(
+              query: {
+                page: page,
+                pagelen: per_page || default_elements_per_page,
+              },
+            )
+          )
+        end
+      end
+
+      def branch(owner:, repo:, branch:)
+        with_response_validation! do
+          self.class.get(
+            "/repositories/#{owner}/#{repo}/refs/branches/#{branch}",
+            default_options
+          )
+        end
+      end
+
+      def download_repo_archive(owner:, repo:, branch: nil)
+        Down.download("#{download_url}/#{owner}/#{repo}/get/#{branch}.zip", down_default_options)
+      end
+
+      def setup_repo_webhook(owner:, repo:, webhook_url:, webhook_secret: nil)
+        with_response_validation! do
+          self.class.post(
+            "/repositories/#{owner}/#{repo}/hooks",
+            default_options.merge(
+              body: {
+                description: 'webhook',
+                url: webhook_secret ? "#{webhook_url}?secret=#{webhook_secret}" : webhook_url,
+                active: true,
+                events: [
+                  'repo:push',
+                ],
+              }.to_json,
+            )
+          )
+        end
+      end
+
+      def delete_repo_webhook(owner:, repo:, webhook_id:)
+        with_response_validation! do
+          self.class.delete(
+            "/repositories/#{owner}/#{repo}/hooks/#{webhook_id}",
+            default_options
+          )
+        end
+      end
+    end
+  end
+end

data/lib/universal-git-client/http/bitbucket_server.rb

@@ -0,0 +1,134 @@
+require 'universal-git-client/http/base'
+require 'universal-git-client/http/helpers/dummy_response'
+
+module UniversalGitClient
+  module Http
+    class BitbucketServer < Base
+      def user
+        Helpers::DummyResponse.response(options: default_options)
+      end
+
+      def organizations(page: 1, per_page: nil)
+        options = default_options.merge(
+          query: {
+            start: limit(per_page) * (page - 1),
+            limit: limit(per_page)
+          }
+        )
+        body = {
+          size: 0,
+          start: 0,
+          limit: limit(per_page),
+          values: []
+        }
+        Helpers::DummyResponse.response(body: body, options: options)
+      end
+
+      def user_repos(page: 1, per_page: nil)
+        with_response_validation! do
+          self.class.get(
+            '/repos',
+            default_options.merge(
+              query: {
+                state: 'AVAILABLE',
+                start: limit(per_page) * (page - 1),
+                limit: limit(per_page)
+              }
+            )
+          )
+        end
+      end
+
+      def orga_repos(organization:, page: 1, per_page: nil)
+        options =  default_options.merge(
+          query: {
+            start: limit(per_page) * (page - 1),
+            limit: limit(per_page)
+          }
+        )
+        body = {
+          size: 0,
+          start: 0,
+          limit: limit(per_page),
+          values: []
+        }
+        Helpers::DummyResponse.response(body: body, options: options)
+      end
+
+      def repository(owner:, repo:)
+        with_response_validation! do
+          self.class.get("/projects/#{owner}/repos/#{repo}", default_options)
+        end
+      end
+
+      def branches(owner:, repo:, page: 1, per_page: nil)
+        with_response_validation! do
+          self.class.get(
+            "/projects/#{owner}/repos/#{repo}/branches",
+            default_options.merge(
+              query: {
+                start: limit(per_page) * (page - 1),
+                limit: limit(per_page)
+              }
+            )
+          )
+        end
+      end
+
+      def branch(owner:, repo:, branch:)
+        with_response_validation! do
+          response = self.class.get(
+            "/projects/#{owner}/repos/#{repo}/branches",
+            default_options.merge(
+              query: {
+                filterText: branch,
+                limit: 1
+              }
+            )
+          )
+          Helpers::DummyResponse.response(request: response.request, body: response.parsed_response['values'].first)
+        end
+      end
+
+      def download_repo_archive(owner:, repo:, branch: nil)
+        Down.download("#{base_url}/projects/#{owner}/repos/#{repo}/archive?at=#{branch}&format=zip", down_default_options)
+      end
+
+      def setup_repo_webhook(owner:, repo:, webhook_url:, webhook_secret: nil)
+        with_response_validation! do
+          self.class.post(
+            "/projects/#{owner}/repos/#{repo}/webhooks",
+            default_options.merge(
+              body: {
+                name: 'webhook',
+                url: webhook_url,
+                active: true,
+                events: [
+                  'repo:refs_changed'
+                ],
+                configuration: {
+                  secret: webhook_secret
+                }
+              }.to_json
+            )
+          )
+        end
+      end
+
+      def delete_repo_webhook(owner:, repo:, webhook_id:)
+        with_response_validation! do
+          self.class.delete(
+            "/projects/#{owner}/repos/#{repo}/webhooks/#{webhook_id}",
+            default_options
+          )
+        end
+      end
+
+      private
+
+      def limit(per_page)
+        per_page || default_elements_per_page
+      end
+    end
+  end
+end