haveapi-go-client 0.19.3 → 0.21.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e280d2ae1a1a0bad8fb3436d97493f3b15f6accb65e919af2fa7cb0fc751108f
-  data.tar.gz: 21f2f8bdf6ddf4f0d28e994fabbc865be6a0cce7fc1a9f67c868a02ab2d8427f
+  metadata.gz: 7a7636a78332b0aa0b89c5eb21f0d3d0944629c006165e899670677ee3e8e83e
+  data.tar.gz: d1cb9bcd4d094670197d613aaa8775724e02304ed5b073292423056ec33a4621
 SHA512:
-  metadata.gz: 8b520855fe4036001908341c247bf9b71b6868ba91fdbba5dab188b45f479be40bd1dbe12825ee2499d8d1e84ca2d3064ca6e5fe8b70111b6490288662a6a7b4
-  data.tar.gz: 570f73252a60726a109e3c23bddbc5f09aa3f2543f9706d8db4a901e96ea7fa87bccbaf4dd13aa713bc695b795097137f1fb6452255354e06f89b808e3b897db
+  metadata.gz: 8b67cc15963852f808c5554acdd668b6813e2b06d6ff721d3157fc348de8bd466399fd14bd73e5c8571b678305ad4198b31db0b284070acef090172f3186e7e4
+  data.tar.gz: f9932502872003d594552901d06895a62869abb4feb2e289546e4c7659c73fbb98180d85fbe9c867dd8e09416d20dca16736925c42f1c6fc1c23a0e030e004f3

data/Gemfile

@@ -2,3 +2,8 @@ source 'https://rubygems.org'
 gemspec
 
 gem 'haveapi-client', path: '../ruby'
+
+group :development do
+  gem 'bundler'
+  gem 'rake'
+end

data/haveapi-go-client.gemspec

@@ -1,6 +1,5 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+lib = File.expand_path('lib', __dir__)
+$:.unshift(lib) unless $:.include?(lib)
 require 'haveapi/go_client/version'
 
 Gem::Specification.new do |spec|
@@ -9,17 +8,15 @@ Gem::Specification.new do |spec|
   spec.authors       = ['Jakub Skokan']
   spec.email         = ['jakub.skokan@vpsfree.cz']
   spec.summary       =
-  spec.description   = 'Go client generator'
+    spec.description = 'Go client generator'
   spec.homepage      = ''
   spec.license       = 'MIT'
 
+  spec.required_ruby_version = ">= #{File.read('../../.ruby-version').strip}"
+
   spec.files         = `git ls-files -z`.split("\x0")
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler'
-  spec.add_development_dependency 'rake'
-
-  spec.add_runtime_dependency 'haveapi-client', '~> 0.19.3'
+  spec.add_runtime_dependency 'haveapi-client', '~> 0.21.0'
 end

data/lib/haveapi/go_client/action.rb

@@ -59,12 +59,12 @@ module HaveAPI::GoClient
       @name = name.to_s
       @prefix = prefix
       @aliases = desc[:aliases]
-      @full_dot_name = resource.full_dot_name + '#' + @name.capitalize
+      @full_dot_name = "#{resource.full_dot_name}##{@name.capitalize}"
       @go_name = camelize(name)
       @go_type = full_go_type
-      @go_invocation_type = go_type + 'Invocation'
-      @go_request_type = go_type + 'Request'
-      @go_response_type = go_type + 'Response'
+      @go_invocation_type = "#{go_type}Invocation"
+      @go_request_type = "#{go_type}Request"
+      @go_response_type = "#{go_type}Response"
       @input = desc[:input] && InputOutput.new(self, :io, :input, desc[:input])
       @output = desc[:output] && InputOutput.new(self, :io, :output, desc[:output])
       @http_method = desc[:method]
@@ -96,7 +96,7 @@ module HaveAPI::GoClient
     end
 
     def input_output
-      %i(input output).select do |v|
+      %i[input output].select do |v|
         send(v) && send(v).parameters.any?
       end.map { |v| send(v) }
     end
@@ -106,9 +106,7 @@ module HaveAPI::GoClient
     end
 
     def resolve_associations
-      input_output.each do |io|
-        io.resolve_associations
-      end
+      input_output.each(&:resolve_associations)
 
       metadata && metadata.resolve_associations
     end
@@ -118,6 +116,7 @@ module HaveAPI::GoClient
     end
 
     protected
+
     attr_reader :prefix
 
     def full_go_type
@@ -126,7 +125,7 @@ module HaveAPI::GoClient
       names << 'Action'
       names.concat(resource.resource_path.map(&:go_name))
       names << go_name
-      names.join('')
+      names.join
     end
   end
 end

data/lib/haveapi/go_client/api_version.rb

@@ -14,7 +14,7 @@ module HaveAPI::GoClient
         Resource.new(self, k, v)
       end.sort!
 
-      @resources.each { |r| r.resolve_associations }
+      @resources.each(&:resolve_associations)
 
       @auth_methods = desc[:authentication].map do |k, v|
         AuthenticationMethods.new(self, k, v)

data/lib/haveapi/go_client/authentication/base.rb

@@ -5,6 +5,8 @@ module HaveAPI::GoClient
       AuthenticationMethods.register(name, self)
     end
 
+    def initialize(api_version, name, desc); end
+
     # @param dst [String]
     def generate(dst)
       raise NotImplementedError

data/lib/haveapi/go_client/authentication/basic.rb

@@ -4,15 +4,11 @@ module HaveAPI::GoClient
   class Authentication::Basic < Authentication::Base
     register :basic
 
-    def initialize(api_version, name, desc)
-
-    end
-
     def generate(gen)
       ErbTemplate.render_to_if_changed(
         'authentication/basic.go',
         {
-          package: gen.package,
+          package: gen.package
         },
         File.join(gen.dst, 'auth_basic.go')
       )

data/lib/haveapi/go_client/authentication/oauth2.rb

@@ -0,0 +1,32 @@
+require 'haveapi/go_client/authentication/base'
+
+module HaveAPI::GoClient
+  class Authentication::OAuth2 < Authentication::Base
+    register :oauth2
+
+    # HTTP header the token is sent in
+    # @return [String]
+    attr_reader :http_header
+
+    # Token revocation URL
+    # @return [String]
+    attr_reader :revoke_url
+
+    def initialize(api_version, name, desc)
+      super
+      @http_header = desc[:http_header]
+      @revoke_url = desc[:revoke_url]
+    end
+
+    def generate(gen)
+      ErbTemplate.render_to_if_changed(
+        'authentication/oauth2.go',
+        {
+          package: gen.package,
+          auth: self
+        },
+        File.join(gen.dst, 'auth_oauth2.go')
+      )
+    end
+  end
+end

data/lib/haveapi/go_client/authentication/token.rb

@@ -17,13 +17,14 @@ module HaveAPI::GoClient
     attr_reader :resource
 
     def initialize(api_version, name, desc)
+      super
       @http_header = desc[:http_header]
       @query_parameter = desc[:query_parameter]
       @resource = Resource.new(
         api_version,
         :token,
         desc[:resources][:token],
-        prefix: 'auth_token',
+        prefix: 'auth_token'
       )
       resource.resolve_associations
     end
@@ -33,7 +34,7 @@ module HaveAPI::GoClient
         'authentication/token.go',
         {
           package: gen.package,
-          auth: self,
+          auth: self
         },
         File.join(gen.dst, 'auth_token.go')
       )
@@ -49,7 +50,7 @@ module HaveAPI::GoClient
     # @return [Array<Action>]
     def custom_actions
       @custom_actions ||= resource.actions.reject do |a|
-        %w(request renew revoke).include?(a.name)
+        %w[request renew revoke].include?(a.name)
       end
     end
   end

data/lib/haveapi/go_client/authentication/unsupported.rb

@@ -3,11 +3,10 @@ require 'haveapi/go_client/authentication/base'
 module HaveAPI::GoClient
   class Authentication::Unsupported < Authentication::Base
     def initialize(api_version, name, desc)
+      super
       warn "Ignoring unsupported authentication method #{name}"
     end
 
-    def generate(gen)
-
-    end
+    def generate(gen); end
   end
 end

data/lib/haveapi/go_client/authentication_methods.rb

@@ -1,5 +1,5 @@
 module HaveAPI::GoClient
-  module Authentication ; end
+  module Authentication; end
 
   module AuthenticationMethods
     # @param name [Symbol]
@@ -16,9 +16,9 @@ module HaveAPI::GoClient
 
     # @param api_version [ApiVersion]
     # @param name [String]
-    def self.new(api_version, name, *args)
+    def self.new(api_version, name, *)
       klass = get(name) || Authentication::Unsupported
-      klass.new(api_version, name, *args)
+      klass.new(api_version, name, *)
     end
   end
 end

data/lib/haveapi/go_client/cli.rb

@@ -5,7 +5,7 @@ module HaveAPI::GoClient
   class Cli
     def self.run
       options = {
-        package: 'client',
+        package: 'client'
       }
 
       parser = OptionParser.new do |opts|

data/lib/haveapi/go_client/erb_template.rb

@@ -26,7 +26,7 @@ module HaveAPI::GoClient
     end
 
     def initialize(name, vars)
-      @_tpl = ERB.new(File.new(HaveAPI::GoClient.tpl(name)).read, 0, '-')
+      @_tpl = ERB.new(File.new(HaveAPI::GoClient.tpl(name)).read, trim_mode: '-')
 
       vars.each do |k, v|
         if v.is_a?(Proc)

data/lib/haveapi/go_client/generator.rb

@@ -36,7 +36,7 @@ module HaveAPI::GoClient
       if self.module
         ErbTemplate.render_to_if_changed(
           'go.mod',
-          {mod: self.module},
+          { mod: self.module },
           File.join(dst, 'go.mod')
         )
 
@@ -44,12 +44,12 @@ module HaveAPI::GoClient
         FileUtils.mkpath(dst)
       end
 
-      %w(client authentication request response types).each do |v|
+      %w[client authentication request response types].each do |v|
         ErbTemplate.render_to_if_changed(
           "#{v}.go",
           {
-            package: package,
-            api: api,
+            package:,
+            api:
           },
           File.join(dst, "#{v}.go")
         )
@@ -60,12 +60,13 @@ module HaveAPI::GoClient
     end
 
     def go_fmt
-      unless system('go', 'fmt', chdir: dst)
-        fail "go fmt failed"
-      end
+      return if system('go', 'fmt', chdir: dst)
+
+      raise 'go fmt failed'
     end
 
     protected
+
     attr_reader :api
   end
 end

data/lib/haveapi/go_client/input_output.rb

@@ -37,12 +37,12 @@ module HaveAPI::GoClient
       @parameters = desc[:parameters].map do |k, v|
         Parameter.new(role, direction, self, k.to_s, v)
       end.compact.sort!
-      @go_type = action.go_type + (prefix ? prefix : '') + direction.to_s.capitalize
+      @go_type = action.go_type + (prefix || '') + direction.to_s.capitalize
       @go_namespace = camelize(desc[:namespace])
     end
 
     def resolve_associations
-      parameters.each { |p| p.resolve }
+      parameters.each(&:resolve)
     end
   end
 end

data/lib/haveapi/go_client/metadata.rb

@@ -46,8 +46,8 @@ module HaveAPI::GoClient
       object && object.resolve_associations
     end
 
-    %i(global object).each do |type|
-      %i(input output).each do |dir|
+    %i[global object].each do |type|
+      %i[input output].each do |dir|
         define_method(:"has_#{type}_#{dir}?") do
           t = send(type)
           next(false) unless t

data/lib/haveapi/go_client/parameter.rb

@@ -1,5 +1,5 @@
 module HaveAPI::GoClient
-  module Parameters ; end
+  module Parameters; end
 
   module Parameter
     # @param klass [Class]
@@ -16,8 +16,8 @@ module HaveAPI::GoClient
     # @param desc [Hash]
     # @return [Parameters::Base, nil]
     def self.new(role, direction, io, name, desc)
-      klass, _ =
-        @handlers.select do |klass, block|
+      klass, =
+        @handlers.select do |_klass, block|
           block.call(role, direction, name, desc)
         end.first
 

data/lib/haveapi/go_client/parameters/association.rb

@@ -28,6 +28,7 @@ module HaveAPI::GoClient
     end
 
     protected
+
     def find_resource(path)
       root = parameter.io.action.resource.api_version
       path = path.clone
@@ -37,7 +38,7 @@ module HaveAPI::GoClient
         resource = root.resources.detect { |r| r.name == name }
 
         if resource.nil?
-          fail "associated resource '#{name}' not found in "+
+          raise "associated resource '#{name}' not found in " +
                 (root.is_a?(ApiVersion) ? 'root' : root.resource_path.map(&:name).join('.'))
 
         elsif path.empty?
@@ -48,7 +49,7 @@ module HaveAPI::GoClient
         end
       end
 
-      fail 'programming error'
+      raise 'programming error'
     end
   end
 end

data/lib/haveapi/go_client/parameters/base.rb

@@ -64,11 +64,10 @@ module HaveAPI::GoClient
     end
 
     protected
+
     # @return [Hash]
     attr_reader :desc
 
-    def do_resolve
-
-    end
+    def do_resolve; end
   end
 end

data/lib/haveapi/go_client/parameters/global_meta_includes.rb

@@ -10,6 +10,7 @@ module HaveAPI::GoClient
     end
 
     protected
+
     def do_resolve
       @go_in_type = @go_out_type = 'string'
     end

data/lib/haveapi/go_client/parameters/resource.rb

@@ -2,7 +2,7 @@ require 'haveapi/go_client/parameters/base'
 
 module HaveAPI::GoClient
   class Parameters::Resource < Parameters::Base
-    handle do |role, direction, name, desc|
+    handle do |_role, _direction, _name, desc|
       desc[:type] == 'Resource'
     end
 
@@ -15,6 +15,7 @@ module HaveAPI::GoClient
     end
 
     protected
+
     def do_resolve
       @association = Parameters::Association.new(self, desc)
       @go_in_type = 'int64'

data/lib/haveapi/go_client/parameters/typed.rb

@@ -2,11 +2,12 @@ require 'haveapi/go_client/parameters/base'
 
 module HaveAPI::GoClient
   class Parameters::Typed < Parameters::Base
-    handle do |role, direction, name, desc|
-      !%w(Custom Resource).include?(desc[:type])
+    handle do |_role, _direction, _name, desc|
+      !%w[Custom Resource].include?(desc[:type])
     end
 
     protected
+
     def do_resolve
       @go_in_type = get_go_type(desc[:type])
       @go_out_type = get_go_type(desc[:type])
@@ -23,7 +24,7 @@ module HaveAPI::GoClient
       when 'Boolean'
         'bool'
       else
-        fail "unsupported data type '#{v}'"
+        raise "unsupported data type '#{v}'"
       end
     end
   end

data/lib/haveapi/go_client/resource.rb

@@ -48,7 +48,7 @@ module HaveAPI::GoClient
         Resource.new(self, k, v)
       end.sort!
       @actions = desc[:actions].map do |k, v|
-        Action.new(self, k.to_s, v, prefix: prefix)
+        Action.new(self, k.to_s, v, prefix:)
       end.sort!
     end
 
@@ -78,8 +78,8 @@ module HaveAPI::GoClient
     end
 
     def resolve_associations
-      actions.each { |a| a.resolve_associations }
-      resources.each { |r| r.resolve_associations }
+      actions.each(&:resolve_associations)
+      resources.each(&:resolve_associations)
     end
 
     def generate(gen)
@@ -87,7 +87,7 @@ module HaveAPI::GoClient
         'resource.go',
         {
           package: gen.package,
-          resource: self,
+          resource: self
         },
         File.join(gen.dst, prefix_underscore("resource_#{full_name}.go"))
       )
@@ -99,7 +99,7 @@ module HaveAPI::GoClient
           'action.go',
           {
             package: gen.package,
-            action: a,
+            action: a
           },
           File.join(gen.dst, prefix_underscore("resource_#{full_name}_action_#{a.name}.go"))
         )
@@ -111,6 +111,7 @@ module HaveAPI::GoClient
     end
 
     protected
+
     attr_reader :prefix
 
     def prefix_underscore(s)
@@ -133,7 +134,7 @@ module HaveAPI::GoClient
       names = ['Resource']
       names.concat(parent_resources.map(&:go_name))
       names << go_name
-      prefix_camel(names.join(''))
+      prefix_camel(names.join)
     end
   end
 end

data/lib/haveapi/go_client/utils.rb

@@ -4,7 +4,7 @@ module HaveAPI::GoClient
     # @param v [String]
     # @return [String]
     def camelize(v)
-      v.to_s.split('_').map(&:capitalize).join('')
+      v.to_s.split('_').map(&:capitalize).join
     end
   end
 end

data/lib/haveapi/go_client/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module GoClient
-    VERSION = '0.19.3'
+    VERSION = '0.21.0'.freeze
   end
 end

data/template/authentication/oauth2.go.erb

@@ -0,0 +1,53 @@
+package <%= package %>
+
+import (
+	"fmt"
+	"net/http"
+)
+
+type OAuth2Auth struct {
+	// The authentication token
+	AccessToken string
+}
+
+func (auth *OAuth2Auth) Authenticate(request *http.Request) {
+	request.Header.Set("<%= auth.http_header %>", auth.AccessToken)
+}
+
+// SetExistingTokenAuth will use a previously acquired access token
+func (client *Client) SetExistingOAuth2Auth(accessToken string) {
+	client.Authentication = &OAuth2Auth{
+		AccessToken: accessToken,
+	}
+}
+
+// RevokeAuthToken will revoke the access token and remove authentication
+// from the client
+func (client *Client) RevokeAccessToken() error {
+	httpClient := &http.Client{}
+
+	req, err := http.NewRequest("POST", "<%= auth.revoke_url %>", nil)
+
+	if err != nil {
+		return err
+	}
+
+	if client.Authentication != nil {
+		client.Authentication.Authenticate(req)
+	}
+
+	resp, err := httpClient.Do(req)
+
+	if err != nil {
+		return err
+	}
+
+	defer resp.Body.Close()
+
+	if resp.StatusCode != 200 {
+		return fmt.Errorf("Unable to revoke access token, HTTP %v", resp.StatusCode)
+	}
+
+	client.Authentication = nil
+	return nil
+}

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-go-client
 version: !ruby/object:Gem::Version
-  version: 0.19.3
+  version: 0.21.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -10,48 +10,20 @@ bindir: bin
 cert_chain: []
 date: 1980-01-01 00:00:00.000000000 Z
 dependencies:
-- !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-- !ruby/object:Gem::Dependency
-  name: rake
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: haveapi-client
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.21.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.19.3
+        version: 0.21.0
 description: Go client generator
 email:
 - jakub.skokan@vpsfree.cz
@@ -71,6 +43,7 @@ files:
 - lib/haveapi/go_client/api_version.rb
 - lib/haveapi/go_client/authentication/base.rb
 - lib/haveapi/go_client/authentication/basic.rb
+- lib/haveapi/go_client/authentication/oauth2.rb
 - lib/haveapi/go_client/authentication/token.rb
 - lib/haveapi/go_client/authentication/unsupported.rb
 - lib/haveapi/go_client/authentication_methods.rb
@@ -92,6 +65,7 @@ files:
 - template/action.go.erb
 - template/authentication.go.erb
 - template/authentication/basic.go.erb
+- template/authentication/oauth2.go.erb
 - template/authentication/token.go.erb
 - template/client.go.erb
 - template/go.mod.erb
@@ -111,7 +85,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 3.2.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="