haveapi 0.16.3 → 0.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ece538baf23fb6e02ef9ad1063930cc7b973e94fc530e4f96fa87f0e19ecd269
-  data.tar.gz: 73b6713727754b11ce89e3c61017b4374ced36f50c740c9594f757d11685e640
+  metadata.gz: 4799af18ce8de3147686153493e32210e780c650bdcec3e18f5ff714da50ee03
+  data.tar.gz: 4cfe8ff071d7d4ea6adcb28e25ab0d491008e9402058c34293bdf70881bf13e2
 SHA512:
-  metadata.gz: 6db1b965c6fac2ad2669709397e81d028e2e9828707dc6727b65b70cf0ceea5d8c8d38be82659a6c959687336529345b873c6fe2f81b779b83f96a86fe27c5c9
-  data.tar.gz: a6e64201797808898c504837f4f867bb0f017735e1b6f5558414026e78fb637089482e1479525ba7d1f1885d3c72eb3f165239b3acc1d164de702ef8762c26f1
+  metadata.gz: 936f0c86ff2b766339c3dbc08d49c2ae46868002733124dad9987ad932f9232807160a6a36777fc6fe45b952682e89bf9b0a5856939d6a7a1775e94e9d8ffe4c
+  data.tar.gz: 3527985845485151a532aa42ce235eed35827f8d9f6a2aa053b208e7621ce4d93f578cd531f06aec8bcc27ecd1079c8023b7fc63f29bf36d4b6e38807121f0f6

data/haveapi.gemspec

@@ -16,13 +16,13 @@ Gem::Specification.new do |s|
 
   s.add_runtime_dependency 'require_all', '~> 2.0.0'
   s.add_runtime_dependency 'json'
-  s.add_runtime_dependency 'activesupport', '>= 6.0'
-  s.add_runtime_dependency 'sinatra', '~> 3.0.4'
-  s.add_runtime_dependency 'tilt', '~> 2.0.10'
-  s.add_runtime_dependency 'redcarpet', '~> 3.5'
+  s.add_runtime_dependency 'activesupport', '>= 7.0'
+  s.add_runtime_dependency 'sinatra', '~> 3.1.0'
+  s.add_runtime_dependency 'tilt', '~> 2.3.0'
+  s.add_runtime_dependency 'redcarpet', '~> 3.6'
   s.add_runtime_dependency 'rake'
   s.add_runtime_dependency 'github-markdown'
   s.add_runtime_dependency 'nesty', '~> 1.0'
-  s.add_runtime_dependency 'haveapi-client', '~> 0.16.3'
+  s.add_runtime_dependency 'haveapi-client', '~> 0.17.0'
   s.add_runtime_dependency 'mail'
 end

data/lib/haveapi/client_example.rb

@@ -79,5 +79,28 @@ module HaveAPI
     def version_url
       File.join(base_url, "v#{version}", '/')
     end
+
+    protected
+    # @param password [Boolean] include password parameter
+    # @return [Hash<String, String>] parameter => example value
+    def auth_token_credentials(desc, password: true)
+      passwords = %i(password pass passwd)
+      params = desc[:resources][:token][:actions]['request'][:input][:parameters].keys - %i(lifetime interval)
+
+      unless password
+        params.reject! { |param| passwords.include?(param) }
+      end
+
+      Hash[params.map do |param|
+        value =
+          if passwords.include?(param)
+            'secret'
+          else
+            param
+          end
+
+        [param, value]
+      end]
+    end
   end
 end

data/lib/haveapi/client_examples/curl.rb

@@ -12,8 +12,6 @@ module HaveAPI::ClientExamples
     end
 
     def auth(method, desc)
-      login = {user: 'user', password: 'password', lifetime: 'fixed'}
-
       case method
       when :basic
         <<END
@@ -30,6 +28,8 @@ $ curl --request OPTIONS \\
 END
 
       when :token
+        login = auth_token_credentials(desc).merge(lifetime: 'fixed')
+
         <<END
 # Acquire the token
 $ curl --request POST \\

data/lib/haveapi/client_examples/http.rb

@@ -28,12 +28,14 @@ Authorization: Basic dXNlcjpzZWNyZXQ=
 END
 
       when :token
+        login = auth_token_credentials(desc).merge(lifetime: 'fixed')
+
         <<END
 POST /_auth/token/tokens HTTP/1.1
 Host: #{host}
 Content-Type: application/json
 
-#{JSON.pretty_generate({token: {user: 'user', password: 'secret', lifetime: 'fixed'}})}
+#{JSON.pretty_generate({token: login})}
 END
       end
     end

data/lib/haveapi/client_examples/js_client.rb

@@ -21,7 +21,7 @@ END
 #{init}
 
 api.authenticate("basic", {
-  username: "user",
+  user: "user",
   password: "secret"
 }, function (client, status) {
   console.log("Authenticated?", status);
@@ -34,8 +34,7 @@ END
 
 // Request a new token
 api.authenticate("token", {
-  username: "user",
-  password: "secret"
+  #{auth_token_credentials(desc).map { |k, v| "#{k}: \"#{v}\"" }.join(",\n  ")}
 }, function (client, status) {
   console.log("Authenticated?", status);
 

data/lib/haveapi/client_examples/php_client.rb

@@ -18,7 +18,7 @@ END
         <<END
 #{init}
 
-$api->authenticate("basic", ["username" => "user", "password" => "secret"]);
+$api->authenticate("basic", ["user" => "user", "password" => "secret"]);
 END
 
       when :token
@@ -26,7 +26,7 @@ END
 #{init}
 
 // Get token using username and password
-$api->authenticate("token", ["username" => "user", "password" => "secret"]);
+$api->authenticate("token", [#{auth_token_credentials(desc).map { |k, v| "\"#{k}\" => \"#{v}\"" }.join(', ')}]);
 
 echo "Token = ".$api->getAuthenticationProvider()->getToken();
 

data/lib/haveapi/client_examples/ruby_cli.rb

@@ -20,10 +20,10 @@ module HaveAPI::ClientExamples
       when :basic
         <<END
 # Provide credentials on command line
-#{init} --auth basic --username user --password secret
+#{init} --auth basic --user user --password secret
 
 # If username or password isn't provided, the user is asked on stdin
-#{init} --auth basic --username user
+#{init} --auth basic --user user
 Password: secret
 END
 
@@ -33,7 +33,7 @@ END
 # Note that the client always has to call some action. APIs should provide
 # an action to get information about the current user, so that's what we're
 # calling now.
-#{init} --auth token --username user --save user current
+#{init} --auth token #{auth_token_credentials(desc, password: false).map { |k, v| "--#{k} #{v}" }.join(' ')} --save user current
 Password: secret
 
 # Now the token is read from disk and the user does not have to provide username

data/lib/haveapi/client_examples/ruby_client.rb

@@ -21,7 +21,7 @@ END
         <<END
 #{init}
 
-client.authenticate(:basic, username: "user", password: "secret")
+client.authenticate(:basic, user: "user", password: "secret")
 END
 
       when :token
@@ -29,7 +29,7 @@ END
 #{init}
 
 # Get token using username and password
-client.authenticate(:token, username: "user", password: "secret")
+client.authenticate(:token, #{auth_token_credentials(desc).map { |k, v| "#{k}: \"#{v}\"" }.join(', ')})
 
 puts "Token = \#{client.auth.token}"
 

data/lib/haveapi/version.rb

@@ -1,4 +1,4 @@
 module HaveAPI
   PROTOCOL_VERSION = '2.0'
-  VERSION = '0.16.3'
+  VERSION = '0.17.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: haveapi
 version: !ruby/object:Gem::Version
-  version: 0.16.3
+  version: 0.17.0
 platform: ruby
 authors:
 - Jakub Skokan
@@ -44,56 +44,56 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: '6.0'
+        version: '7.0'
 - !ruby/object:Gem::Dependency
   name: sinatra
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 3.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.4
+        version: 3.1.0
 - !ruby/object:Gem::Dependency
   name: tilt
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.10
+        version: 2.3.0
 - !ruby/object:Gem::Dependency
   name: redcarpet
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.5'
+        version: '3.6'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.16.3
+        version: 0.17.0
 - !ruby/object:Gem::Dependency
   name: mail
   requirement: !ruby/object:Gem::Requirement
@@ -315,7 +315,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.20
+rubygems_version: 3.4.13
 signing_key:
 specification_version: 4
 summary: Framework for creating self-describing APIs