gitlab_client 0.1.0.pre.alpha → 0.1.0.pre.alpha.pre.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5e2071d6c7fc92d058cff4d793ffc24b8fac2990464aee08525f8cfa15e81a4c
-  data.tar.gz: 3e68ca1275c5ce5d80b900b2af8d738c9d97510feb5e94914e1ccd87af734f6c
+  metadata.gz: fece9d5bf2fd375427e82ffecdfa89b05b0c008bbcdfcf148a372954fd00354a
+  data.tar.gz: e806ef4f11d95a3a35ad9844c677e24a64d1d30713a6bae22f51aac97b7ac93c
 SHA512:
-  metadata.gz: c670045a8ab2b663f19626cd33f6b6bfd095d8dfd506fd08e360f2d1a8388a4fbc9c38242a807e8d8b160b1b9a7830a08fe3a64ce7419be9f32b11982907880b
-  data.tar.gz: e1b9dba06c5546a531f76e743a0109eb14195cac1bdaec8cdcc13b2163786f9615b3c2ffae2a504cb73069d3d556825a4ddbce43d3d98ec927859996557294cd
+  metadata.gz: 165e199b2b3b3aa2c6c73c61e881e3c7dfdedeb8e27945e933f3508d3626dc275f50666d2006bb598b9f6b5106a8ebf7950fce48ee5d96e9d52b6e1fe335db96
+  data.tar.gz: 2d34961949191650d58d6644885c8361af62f838a0f9fda4a4c670963c65ead5f32726c02c5658589fbd5674e858dd0bb671343201422768ca5e786ed42eb2a2

data/.rubocop.yml

@@ -1,6 +1,6 @@
 ---
 AllCops:
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.0
 
 Style/StringLiterals:
   Enabled: true

data/Gemfile

@@ -12,3 +12,5 @@ gem "minitest", "~> 5.0"
 gem "rubocop", "~> 1.21"
 
 gem "steep"
+
+gem "webmock"

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    gitlab_client (0.1.0.pre.alpha)
+    gitlab_client (0.1.0.pre.alpha.pre.1)
 
 GEM
   remote: https://rubygems.org/
@@ -11,11 +11,16 @@ GEM
       i18n (>= 1.6, < 2)
       minitest (>= 5.1)
       tzinfo (~> 2.0)
+    addressable (2.8.1)
+      public_suffix (>= 2.0.2, < 6.0)
     ast (2.4.2)
     concurrent-ruby (1.1.10)
+    crack (0.4.5)
+      rexml
     csv (3.2.6)
     ffi (1.15.5)
     fileutils (1.7.0)
+    hashdiff (1.0.1)
     i18n (1.12.0)
       concurrent-ruby (~> 1.0)
     json (2.6.2)
@@ -28,6 +33,7 @@ GEM
     parallel (1.22.1)
     parser (3.1.2.1)
       ast (~> 2.4.1)
+    public_suffix (5.0.1)
     rainbow (3.1.1)
     rake (13.0.6)
     rb-fsevent (0.11.2)
@@ -71,9 +77,14 @@ GEM
     tzinfo (2.0.5)
       concurrent-ruby (~> 1.0)
     unicode-display_width (2.3.0)
+    webmock (3.18.1)
+      addressable (>= 2.8.0)
+      crack (>= 0.3.2)
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
   arm64-darwin-21
+  arm64-darwin-22
 
 DEPENDENCIES
   gitlab_client!
@@ -81,6 +92,7 @@ DEPENDENCIES
   rake (~> 13.0)
   rubocop (~> 1.21)
   steep
+  webmock
 
 BUNDLED WITH
    2.2.33

data/README.md

@@ -26,6 +26,23 @@ Or install it yourself as:
 ```ruby
   GitlabClient::Rest.new(private_token: '<TOKEN>').call( path: 'api/v4/version')
 ```
+
+### Graphql API 
+
+```ruby
+  query = '{ projects { edges { node { id name description } } } }'
+  GitlabClient::Graphql.new(private_token: '<TOKEN>').call(query: query)
+```
+
+
+### Difference between Gitlab gem and GitlabClient gem 
+
+- Gitlab client gem is thin, it does not include helper methods per endpoint, nor CLI
+- Gitlab client gem also supports Graphql WIP
+- Gitlab client gem have built in mechanism for pagination TODO
+- Gitlab client gem does not have global state, you can connect to more than one Gitlab instances from same code safely 
+- Gitlab client gem does not depend on other gems, ie no worry about dependency updates
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -34,7 +51,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gitlab_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tachyons/gitlab_client/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/tachyons/gitlab_client. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/tachyons/gitlab_client/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/Rakefile

@@ -13,4 +13,8 @@ require "rubocop/rake_task"
 
 RuboCop::RakeTask.new
 
-task default: %i[test rubocop]
+task :steep do
+  system "bundle exec steep check"
+end
+
+task default: %i[test rubocop steep]

data/gitlab_client.gemspec

@@ -10,9 +10,9 @@ Gem::Specification.new do |spec|
 
   spec.summary = "Gitlab Client"
   spec.description = "Gitlab API client"
-  spec.homepage = "https://gitlab.com/tachyons/oauth2"
+  spec.homepage = "https://gitlab.com/tachyons-gitlab/gitlab_client"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.7.0"
+  spec.required_ruby_version = ">= 3.0.0"
 
   spec.metadata["homepage_uri"] = spec.homepage
   spec.metadata["source_code_uri"] = spec.homepage

data/lib/gitlab_client/graphql.rb

@@ -9,7 +9,7 @@ module GitlabClient
 
   # Gitlab client
   class Graphql
-    DEFAULT_HEADERS = { "Accept" => "application/json" }.freeze
+    DEFAULT_HEADERS = { "Accept" => "application/json", "Content-Type" => "application/json" }.freeze
     GRAPHQL_ENDPOINT = "api/graphql"
     MAXIMUM_REDIRECTS = 5
     attr_reader :access_token, :refresh_token, :private_token
@@ -21,12 +21,26 @@ module GitlabClient
       @private_token = private_token
     end
 
-    def access_token?
-      !access_token.nil?
+    def call(query:, variables: {})
+      response = Net::HTTP.post(uri, { query: query, variables: variables }.to_json, headers)
+
+      response
+        .then { |res| handle_error(res) }
+        .then { |res| JSON.parse(res.body) }
+    end
+
+    private
+
+    def handle_error(response)
+      case response
+      when Net::HTTPClientError
+        raise Error, JSON.parse(response.body)
+      end
+      response
     end
 
     def valid?
-      !(access_token || refresh_token).nil?
+      !(access_token || private_token).nil?
     end
 
     def headers
@@ -39,23 +53,5 @@ module GitlabClient
     def uri
       URI.join(@host, GRAPHQL_ENDPOINT)
     end
-
-    def call(query:)
-      response = Net::HTTP.post(uri, query)
-
-      response
-        .then { |res| handle_error(res) }
-        .then { |res| JSON.parse(res) }
-    end
-
-    private
-
-    def handle_error(response)
-      case response
-      when Net::HTTPClientError
-        raise Error, JSON.parse(response.body)
-      end
-      response
-    end
   end
 end

data/lib/gitlab_client/rest.rb

@@ -9,7 +9,8 @@ module GitlabClient
 
   # Gitlab client
   class Rest
-    DEFAULT_HEADERS = { "Accept" => "application/json" }.freeze
+    DEFAULT_HEADERS = { "Accept" => "application/json",
+                        "User-Agent" => "gitlab_client #{GitlabClient::VERSION}" }.freeze
     MAXIMUM_REDIRECTS = 5
     attr_reader :access_token, :refresh_token, :private_token
 
@@ -20,39 +21,28 @@ module GitlabClient
       @private_token = private_token
     end
 
-    def access_token?
-      !access_token.nil?
-    end
-
-    def valid?
-      !(access_token || refresh_token).nil?
-    end
-
-    def headers
-      return DEFAULT_HEADERS.merge({ "PRIVATE-TOKEN" => private_token }) if private_token
-      return DEFAULT_HEADERS.merge({ "Authorization" => "Bearer #{access_token}" }) if access_token
-
-      {}
-    end
-
     # rubocop:disable  Metrics/MethodLength,Metrics/AbcSize
     def call(path:, method: "GET", custom_headers: {}, data: {})
-      uri = URI(@host + path)
+      raise ArgumentError, "Provide access token or private token to call API" unless valid?
+
+      req_headers = headers.merge(custom_headers)
+      uri = URI.join(@host, path)
       case method
       when "GET"
-        response = Net::HTTP.get_response(uri, headers.merge(custom_headers))
+        response = Net::HTTP.get_response(uri, req_headers)
       when "POST"
-        response = Net::HTTP.post(uri, data.to_json, headers.merge(custom_headers))
+        response = Net::HTTP.post(uri, data.to_json, headers)
       when "PATCH"
-        response = Net::HTTP.patch(uri, data, headers.merge(custom_headers))
+        response = Net::HTTP.patch(uri, data, headers)
       when "DELETE"
-        response = Net::HTTP.patch(uri, data, headers.merge(custom_headers))
+        response = Net::HTTP.patch(uri, data, headers)
 
       end
 
       response
         .then { |res| handle_redirect(res) }
         .then { |res| handle_error(res) }
+        .then { |res| handle_pagination(res) }
         .then { |res| JSON.parse(res.body) }
     end
     # rubocop:enable  Metrics/MethodLength,Metrics/AbcSize
@@ -86,5 +76,20 @@ module GitlabClient
       end
       response
     end
+
+    def handle_pagination(response)
+      response
+    end
+
+    def valid?
+      !(access_token || private_token).nil?
+    end
+
+    def headers
+      return DEFAULT_HEADERS.merge({ "PRIVATE-TOKEN" => private_token }) if private_token
+      return DEFAULT_HEADERS.merge({ "Authorization" => "Bearer #{access_token}" }) if access_token
+
+      {}
+    end
   end
 end

data/lib/gitlab_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module GitlabClient
-  VERSION = "0.1.0-alpha"
+  VERSION = "0.1.0-alpha-1"
 end

data/sig/gitlab_client/graphql.rbs

@@ -8,17 +8,17 @@ module GitlabClient
     MAXIMUM_REDIRECTS: Integer
     @host: String
 
-    attr_reader access_token: nil
-    attr_reader refresh_token: nil
-    attr_reader private_token: nil
-    def initialize: (?access_token: nil, ?refresh_token: nil, ?private_token: nil, ?host: String) -> void
-    def access_token?: -> false
+    attr_reader access_token: String?
+    attr_reader refresh_token: String?
+    attr_reader private_token: String?
+    def initialize: (?access_token: String?, ?refresh_token: String?, ?private_token: String?, ?host: String) -> void
+    def access_token?: -> bool
     def valid?: -> bool
     def headers: -> Hash[String, String?]
     def uri: -> URI::Generic
-    def call: (query: untyped) -> untyped
+    def call: (query: String, ?variables: Hash[String, String?]) -> JSON
 
     private
-    def handle_error: (untyped response) -> untyped
+    def handle_error: (Net::HTTP| Net::HTTPResponse response) -> (Net::HTTP |  Net::HTTPResponse)
   end
 end

data/sig/gitlab_client/rest.rbs

@@ -7,14 +7,14 @@ module GitlabClient
     MAXIMUM_REDIRECTS: Integer
     @host: String
 
-    attr_reader access_token: nil
-    attr_reader refresh_token: nil
-    attr_reader private_token: nil
-    def initialize: (?access_token: nil, ?refresh_token: nil, ?private_token: nil, ?host: String) -> void
-    def access_token?: -> false
-    def valid?: -> false
+    attr_reader access_token: String?
+    attr_reader refresh_token: String?
+    attr_reader private_token: String?
+    def initialize: (?access_token: String?, ?refresh_token: String?, ?private_token: String?, ?host: String) -> void
+    def access_token?: -> bool
+    def valid?: -> bool
     def headers: -> Hash[String, String?]
-    def call: (path: untyped, ?method: String, ?custom_headers: Hash[untyped, untyped], ?data: Hash[untyped, untyped]) -> untyped
+    def call: (path: String, ?method: String, ?custom_headers: Hash[String, String?], ?data: Hash[String, String?]) -> JSON
 
     private
     def handle_redirect: (Net::HTTP | ::Net::HTTPResponse response, ?Integer limit) -> (Net::HTTP | Net::HTTPSuccess| ::Net::HTTPResponse| nil)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gitlab_client
 version: !ruby/object:Gem::Version
-  version: 0.1.0.pre.alpha
+  version: 0.1.0.pre.alpha.pre.1
 platform: ruby
 authors:
 - Aboobacker MK
@@ -36,13 +36,13 @@ files:
 - sig/gitlab_client.rbs
 - sig/gitlab_client/graphql.rbs
 - sig/gitlab_client/rest.rbs
-homepage: https://gitlab.com/tachyons/oauth2
+homepage: https://gitlab.com/tachyons-gitlab/gitlab_client
 licenses:
 - MIT
 metadata:
-  homepage_uri: https://gitlab.com/tachyons/oauth2
-  source_code_uri: https://gitlab.com/tachyons/oauth2
-  changelog_uri: https://gitlab.com/tachyons/oauth2
+  homepage_uri: https://gitlab.com/tachyons-gitlab/gitlab_client
+  source_code_uri: https://gitlab.com/tachyons-gitlab/gitlab_client
+  changelog_uri: https://gitlab.com/tachyons-gitlab/gitlab_client
 post_install_message:
 rdoc_options: []
 require_paths:
@@ -51,7 +51,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.7.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">"