haveapi-go-client 0.29.5 → 0.29.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0c01550d0855ee797d70262f9e58865b8ae4746a40f28bff0db9ae41753fa98d
-  data.tar.gz: 8e4d6c3ae75b9f1372b83745d1fe1e410318ea0f97eefe95a667faaa6aaa0adc
+  metadata.gz: 87fc318cd53bb26a499a61928aabce8b28971e9d941dcf02f01748c8c4483d5f
+  data.tar.gz: 9dd0dfa4aea746dfb0845532cf7e01e24d660e1916029ad21ac6e1656366e6d1
 SHA512:
-  metadata.gz: 653d4d280f32e875ba56c9142bd396013afcb806010da65cb192e8789f856f2fea6cae53e2e60330d359385e8616b46a8150820794c01099608ea11a44557b7e
-  data.tar.gz: 5d269f12efb123784ea35b2431b37f5850f72a2e32de18ba91a14d3d64e221ed871e8dfc4091eff48bf4823cf69b6e81f39bcd6b6f5d82773a67854bf945d6ed
+  metadata.gz: 9c4d4996b2ea0f7d0697303c190f099542d1fed2672abbfeafc74e87518cfc57468e0a4dbb76ee4607e32678e5c72f8f89490e9cd990b3a000ffe4d863525c14
+  data.tar.gz: 8f5b45390fdb4e21ddb47e37e4d1fb68fbc105b2058fd22b48e321d0f352f3b236ab170468055acd4c80c210cb4c574699b9968976a482d0b429a6157a022d60

data/README.md

@@ -76,4 +76,5 @@ api.SetLanguage("cs")
 
 The value is sent in `Accept-Language` by default. Use
 `SetLanguageHeader("X-Language")` when the API is configured with a custom
-language header.
+language header. Read the configured values with `GetLanguage()` and
+`GetLanguageHeader()`.

data/haveapi-go-client.gemspec

@@ -18,5 +18,5 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_dependency 'haveapi-client', '~> 0.29.5'
+  spec.add_dependency 'haveapi-client', '~> 0.29.6'
 end

data/lib/haveapi/go_client/action.rb

@@ -27,6 +27,10 @@ module HaveAPI::GoClient
     # @return [String]
     attr_reader :go_name
 
+    # Names of fields for the action and its aliases in the resource Go struct
+    # @return [Array<String>]
+    attr_reader :go_member_names
+
     # Data type for Go
     # @return [String]
     attr_reader :go_type
@@ -78,10 +82,31 @@ module HaveAPI::GoClient
       @blocking = desc[:blocking]
     end
 
-    # Return action name with all aliases, camelized
+    # Return allocated action member names, including aliases.
     # @return [Array<String>]
     def all_names(&)
-      ([go_name] + aliases.map { |v| camelize(v) }).uniq.each(&)
+      go_member_names.each(&)
+    end
+
+    # @return [String]
+    def go_member_name
+      go_member_names.first
+    end
+
+    # @param allocator [MemberNameAllocator]
+    def allocate_member_names(allocator)
+      @go_member_names = ([name] + aliases.map(&:to_s)).uniq.map do |raw_name|
+        allocator.allocate(
+          camelize(raw_name),
+          suffix: 'Action',
+          identity: [
+            'action',
+            resource.resource_path.map(&:name).join('/'),
+            name,
+            raw_name
+          ].join(':')
+        )
+      end
     end
 
     # @return [Boolean]
@@ -116,7 +141,7 @@ module HaveAPI::GoClient
     end
 
     def <=>(other)
-      go_name <=> other.go_name
+      [go_name, name] <=> [other.go_name, other.name]
     end
 
     protected

data/lib/haveapi/go_client/api_version.rb

@@ -1,5 +1,37 @@
+require 'haveapi/go_client/utils'
+
 module HaveAPI::GoClient
   class ApiVersion
+    CLIENT_MEMBERS = %w[
+      AllowOAuth2Origin
+      Authentication
+      DoBodyRequest
+      DoQueryStringRequest
+      GetLanguage
+      GetLanguageHeader
+      SetHTTPClient
+      SetLanguage
+      SetLanguageHeader
+      SetTimeout
+      Url
+    ].freeze
+
+    AUTHENTICATION_CLIENT_MEMBERS = {
+      basic: %w[
+        SetBasicAuthentication
+      ],
+      oauth2: %w[
+        RevokeAccessToken
+        SetExistingOAuth2Auth
+      ],
+      token: %w[
+        RevokeAuthToken
+        SetExistingTokenAuth
+        SetNewTokenAuth
+        SetTokenAuthMode
+      ]
+    }.freeze
+
     # @return [Array<Authentication::Base>]
     attr_reader :auth_methods
 
@@ -14,6 +46,10 @@ module HaveAPI::GoClient
         Resource.new(self, k, v)
       end.sort!
 
+      client_members = CLIENT_MEMBERS + desc[:authentication].keys.flat_map do |name|
+        AUTHENTICATION_CLIENT_MEMBERS.fetch(name.to_sym, [])
+      end
+      Resource.allocate_member_names(@resources, [], reserved: client_members)
       @resources.each(&:resolve_associations)
 
       @auth_methods = desc[:authentication].map do |k, v|

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

@@ -47,6 +47,11 @@ module HaveAPI::GoClient
       @request_action ||= resource.actions.detect { |a| a.name == 'request' }
     end
 
+    # @return [Action]
+    def revoke_action
+      @revoke_action ||= resource.actions.detect { |a| a.name == 'revoke' }
+    end
+
     # @return [Array<Action>]
     def custom_actions
       @custom_actions ||= resource.actions.reject do |a|

data/lib/haveapi/go_client/resource.rb

@@ -28,6 +28,10 @@ module HaveAPI::GoClient
     # @return [String]
     attr_reader :go_name
 
+    # Name of the field in the parent Go struct
+    # @return [String]
+    attr_reader :go_member_name
+
     # Type in Go
     # @return [String]
     attr_reader :go_type
@@ -55,6 +59,31 @@ module HaveAPI::GoClient
       @actions = desc[:actions].map do |k, v|
         Action.new(self, k.to_s, v, prefix:)
       end.sort!
+      self.class.allocate_member_names(@resources, @actions, reserved: %w[Client])
+    end
+
+    # @param resources [Array<Resource>]
+    # @param actions [Array<Action>]
+    # @param reserved [Array<String>]
+    def self.allocate_member_names(resources, actions, reserved:)
+      allocator = MemberNameAllocator.new(reserved)
+
+      resources.each do |resource|
+        resource.assign_go_member_name(
+          allocator.allocate(
+            resource.go_name,
+            suffix: 'Resource',
+            identity: "resource:#{resource.resource_path.map(&:name).join('/')}"
+          )
+        )
+      end
+
+      actions.each { |action| action.allocate_member_names(allocator) }
+    end
+
+    # @param name [String]
+    def assign_go_member_name(name)
+      @go_member_name = name
     end
 
     # @return [ApiVersion]
@@ -112,7 +141,7 @@ module HaveAPI::GoClient
     end
 
     def <=>(other)
-      go_name <=> other.go_name
+      [go_name, name] <=> [other.go_name, other.name]
     end
 
     protected

data/lib/haveapi/go_client/utils.rb

@@ -2,6 +2,48 @@ require 'digest/sha1'
 require 'json'
 
 module HaveAPI::GoClient
+  class MemberNameAllocator
+    def initialize(reserved = [])
+      @used = reserved.to_h { |name| [name, true] }
+    end
+
+    # Allocate a Go struct member name while preserving the preferred name
+    # whenever it does not collide with another field or method.
+    #
+    # @param preferred [String]
+    # @param suffix [String]
+    # @param identity [String]
+    # @return [String]
+    def allocate(preferred, suffix:, identity:)
+      return use(preferred) unless @used[preferred]
+
+      suffixed = "#{preferred}#{suffix}"
+      return use(suffixed) unless @used[suffixed]
+
+      digest = Digest::SHA1.hexdigest(identity)
+
+      (8..digest.length).each do |length|
+        candidate = "#{suffixed}_#{digest[0, length]}"
+        return use(candidate) unless @used[candidate]
+      end
+
+      index = 2
+      loop do
+        candidate = "#{suffixed}_#{digest}_#{index}"
+        return use(candidate) unless @used[candidate]
+
+        index += 1
+      end
+    end
+
+    protected
+
+    def use(name)
+      @used[name] = true
+      name
+    end
+  end
+
   module Utils
     GO_KEYWORDS = %w[
       break case chan const continue default defer else fallthrough for func go

data/lib/haveapi/go_client/version.rb

@@ -1,5 +1,5 @@
 module HaveAPI
   module GoClient
-    VERSION = '0.29.5'.freeze
+    VERSION = '0.29.6'.freeze
   end
 end

data/spec/integration/generator_spec.rb

@@ -230,6 +230,12 @@ RSpec.describe HaveAPI::GoClient::Generator do
           if err := c.SetLanguageHeader("X-Language"); err != nil {
             t.Fatalf("set language header failed: %v", err)
           }
+          if got := c.GetLanguage(); got != "cs-CZ" {
+            t.Fatalf("expected configured language cs-CZ, got %q", got)
+          }
+          if got := c.GetLanguageHeader(); got != "X-Language" {
+            t.Fatalf("expected configured language header X-Language, got %q", got)
+          }
 
           httpReq, err := http.NewRequest("GET", "#{base_url}/v1/test", nil)
           if err != nil {
@@ -444,6 +450,144 @@ RSpec.describe HaveAPI::GoClient::Generator do
     end
   end
 
+  it 'allocates resource and action members without hiding client configuration' do
+    description = oauth2_revoke_description
+    description[:resources].merge!(
+      language: {
+        resources: {},
+        actions: {}
+      },
+      set_language: {
+        resources: {},
+        actions: {}
+      },
+      get_language: {
+        resources: {},
+        actions: {}
+      },
+      url: {
+        resources: {},
+        actions: {}
+      },
+      authentication: {
+        resources: {},
+        actions: {}
+      },
+      revoke_access_token: {
+        resources: {},
+        actions: {}
+      },
+      widget: {
+        resources: {
+          client: {
+            resources: {},
+            actions: {}
+          },
+          list: {
+            resources: {},
+            actions: {}
+          }
+        },
+        actions: {
+          run: action_description(
+            method: 'GET',
+            path: '/widgets/run',
+            aliases: %w[client list]
+          )
+        }
+      }
+    )
+
+    Dir.mktmpdir('haveapi-go-client-member-names-') do |dir|
+      communicator = instance_double(
+        HaveAPI::Client::Communicator,
+        describe_api: description
+      )
+      allow(HaveAPI::Client::Communicator).to receive(:new).and_return(communicator)
+
+      generator = described_class.new(
+        'http://unused.example',
+        dir,
+        module: 'example.com/haveapi-member-names',
+        package: 'client'
+      )
+      generator.generate
+      generator.go_fmt
+
+      File.write(File.join(dir, 'client', 'member_names_test.go'), <<~GO)
+        package client
+
+        import "testing"
+
+        func TestCollisionSafeMemberNames(t *testing.T) {
+          c := New("http://unused.example")
+
+          if c.Language == nil {
+            t.Fatalf("language resource is not initialized")
+          }
+          if c.SetLanguageResource == nil || c.GetLanguageResource == nil {
+            t.Fatalf("language method collision resources are not initialized")
+          }
+          if c.UrlResource == nil || c.AuthenticationResource == nil {
+            t.Fatalf("fixed client member collision resources are not initialized")
+          }
+          if c.RevokeAccessTokenResource == nil {
+            t.Fatalf("OAuth2 method collision resource is not initialized")
+          }
+          if c.Widget.ClientResource == nil || c.Widget.List == nil {
+            t.Fatalf("nested resources are not initialized")
+          }
+          if c.Widget.Run != c.Widget.ClientAction {
+            t.Fatalf("client alias does not reference the run action")
+          }
+          if c.Widget.Run != c.Widget.ListAction {
+            t.Fatalf("list alias does not reference the run action")
+          }
+
+          if err := c.SetLanguage("cs-CZ"); err != nil {
+            t.Fatalf("set language failed: %v", err)
+          }
+          if err := c.SetLanguageHeader("X-Language"); err != nil {
+            t.Fatalf("set language header failed: %v", err)
+          }
+          if c.GetLanguage() != "cs-CZ" || c.GetLanguageHeader() != "X-Language" {
+            t.Fatalf("language configuration was not retained")
+          }
+        }
+      GO
+
+      go_out, go_err, go_status = Open3.capture3(
+        { 'CGO_ENABLED' => '0' },
+        'go',
+        'test',
+        './...',
+        chdir: dir
+      )
+      expect(go_status).to be_success, "go test failed: #{go_out}\n#{go_err}"
+    end
+  end
+
+  it 'reserves only authentication methods emitted for the described API' do
+    description = oauth2_revoke_description
+    description[:resources][:revoke_access_token] = {
+      resources: {},
+      actions: {}
+    }
+
+    with_oauth2 = HaveAPI::GoClient::ApiVersion.new(description)
+    oauth2_resource = with_oauth2.resources.detect do |resource|
+      resource.name == 'revoke_access_token'
+    end
+    expect(oauth2_resource.go_member_name).to eq('RevokeAccessTokenResource')
+
+    description[:authentication] = {}
+    without_oauth2 = HaveAPI::GoClient::ApiVersion.new(description)
+    plain_resource = without_oauth2.resources.detect do |resource|
+      resource.name == 'revoke_access_token'
+    end
+    expect(plain_resource.go_member_name).to eq('RevokeAccessToken')
+  end
+
   it 'generates an OAuth2 client that sends the revoke token as form data' do
     Dir.mktmpdir('haveapi-go-client-oauth2-') do |dir|
       communicator = instance_double(

data/template/authentication/token.go.erb

@@ -53,7 +53,7 @@ func (client *Client) SetNewTokenAuth(options *TokenAuthOptions) error {
 	auth := &TokenAuth{Resource: resource, Mode: HttpHeader}
 	auth.setDefaultOptions(options)
 
-	request := resource.Request.Prepare()
+	request := resource.<%= auth.request_action.go_member_name %>.Prepare()
 	request.SetInput(&AuthTokenActionTokenRequestInput{
 <% auth.request_action.input.parameters.each do |p| -%>
 		<%= p.go_name %>: options.<%= p.go_name %>,
@@ -98,7 +98,7 @@ func (auth *TokenAuth) setDefaultOptions(options *TokenAuthOptions) {
 func (auth *TokenAuth) nextAuthenticationStep(options *TokenAuthOptions, action string, token string) error {
 <% auth.custom_actions.each do |a| -%>
 	if action == <%= go_string_literal(a.name) %> {
-		request := auth.Resource.<%= a.go_name %>.Prepare()
+		request := auth.Resource.<%= a.go_member_name %>.Prepare()
 		input := request.NewInput()
 		input.SetToken(token)
 
@@ -162,7 +162,7 @@ func (client *Client) SetTokenAuthMode(mode Mode) {
 // RevokeAuthToken will revoke the authentication token and remove authentication
 // from the client
 func (client *Client) RevokeAuthToken() error {
-	revoke := client.Authentication.(*TokenAuth).Resource.Revoke.Prepare()
+	revoke := client.Authentication.(*TokenAuth).Resource.<%= auth.revoke_action.go_member_name %>.Prepare()
 	resp, err := revoke.Call()
 
 	if err != nil {

data/template/client.go.erb

@@ -13,18 +13,14 @@ type Client struct {
 	// Options for authentication method
 	Authentication Authenticator
 
-	// Language sent to the API server, e.g. "cs" or "cs-CZ".
-	Language string
-
-	// HTTP header used to send Language. Defaults to Accept-Language.
-	LanguageHeader string
-
 	httpClient            *http.Client
 	oauth2TrustedOrigins map[string]struct{}
+	language              string
+	languageHeader        string
 
 <% api.resources.each do |r| -%>
 	// Resource <%= go_comment_text(r.full_dot_name) %>
-	<%= r.go_name %> *<%= r.go_type %>
+	<%= r.go_member_name %> *<%= r.go_type %>
 <% end -%>
 }
 
@@ -36,7 +32,7 @@ func New(url string) *Client {
 	}
 
 <% api.resources.each do |r| -%>
-	c.<%= r.go_name %> = New<%= r.go_type %>(c)
+	c.<%= r.go_member_name %> = New<%= r.go_type %>(c)
 <% end -%>
 
 	return c

data/template/i18n.go.erb

@@ -33,10 +33,15 @@ func (client *Client) SetLanguage(language string) error {
 		return err
 	}
 
-	client.Language = language
+	client.language = language
 	return nil
 }
 
+// GetLanguage returns the configured language request header value.
+func (client *Client) GetLanguage() string {
+	return client.language
+}
+
 // SetLanguageHeader configures the HTTP header used by SetLanguage.
 func (client *Client) SetLanguageHeader(header string) error {
 	if !validHeaderName(header) {
@@ -47,30 +52,35 @@ func (client *Client) SetLanguageHeader(header string) error {
 		return err
 	}
 
-	client.LanguageHeader = header
+	client.languageHeader = header
 	return nil
 }
 
+// GetLanguageHeader returns the configured language header name.
+func (client *Client) GetLanguageHeader() string {
+	return client.languageHeader
+}
+
 func (client *Client) addLanguageHeader(req *http.Request) {
-	if client == nil || req == nil || client.Language == "" {
+	if client == nil || req == nil || client.language == "" {
 		return
 	}
 
-	req.Header.Set(client.languageHeaderName(), client.Language)
+	req.Header.Set(client.languageHeaderName(), client.language)
 }
 
 func (client *Client) languageHeaderName() string {
-	if client == nil || client.LanguageHeader == "" {
+	if client == nil || client.languageHeader == "" {
 		return defaultLanguageHeader
 	}
 
-	return client.LanguageHeader
+	return client.languageHeader
 }
 
 func t(client *Client, key string, values map[string]string) string {
 	language := ""
 	if client != nil {
-		language = client.Language
+		language = client.language
 	}
 
 	return tLanguage(language, key, values)

data/template/resource.go.erb

@@ -7,7 +7,7 @@ type <%= resource.go_type %> struct {
 
 <% resource.resources.each do |r| -%>
 	// Resource <%= go_comment_text(r.full_dot_name) %>
-	<%= r.go_name %> *<%= r.go_type %>
+	<%= r.go_member_name %> *<%= r.go_type %>
 <% end -%>
 <% resource.actions.each do |a| -%>
 <% a.all_names do |go_name| -%>
@@ -25,7 +25,7 @@ func New<%= resource.go_type %>(client *Client) *<%= resource.go_type %> {
 	return &<%= resource.go_type %>{
 		Client: client,
 <% resource.resources.each do |r| -%>
-		<%= r.go_name %>: New<%= r.go_type %>(client),
+		<%= r.go_member_name %>: New<%= r.go_type %>(client),
 <% end -%>
 <% resource.actions.each do |a| -%>
 <% a.all_names do |go_name| -%>

data/template/types.go.erb

@@ -39,8 +39,8 @@ func NewValidationError(client ...*Client) *ValidationError {
 		Errors: make(map[string][]string),
 	}
 
-	if len(client) > 0 && client[0] != nil && client[0].Language != "" {
-		validationErrorLanguages.Store(validationErrorKey(ret), client[0].Language)
+	if len(client) > 0 && client[0] != nil && client[0].language != "" {
+		validationErrorLanguages.Store(validationErrorKey(ret), client[0].language)
 		runtime.SetFinalizer(ret, func(e *ValidationError) {
 			validationErrorLanguages.Delete(validationErrorKey(e))
 		})

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi-go-client
 version: !ruby/object:Gem::Version
-  version: 0.29.5
+  version: 0.29.6
 platform: ruby
 authors:
 - Jakub Skokan
@@ -15,14 +15,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.5
+        version: 0.29.6
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.29.5
+        version: 0.29.6
 description: Go client generator
 email:
 - jakub.skokan@vpsfree.cz