timely-app 1.3.0 → 1.3.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0be07dc2504cd0d663370364349e9c32ba0f224feedd2c8a1d34cdf000236d1a
-  data.tar.gz: 327c2065f8e757bb081c12b266154387989ea3d55d83b3a191af60b7d8a2d35c
+  metadata.gz: c82f58f7c3e0713310beb5653d74487822d9f96bb883ae15805c5987896a589e
+  data.tar.gz: d90c62ee9a7baa1b29468f70997a7b1e5e6236d8553c9d92abfc082855595292
 SHA512:
-  metadata.gz: 78b6bd494db0a7a2c1e2bb75f63573bc5ff74d8dfbce3fcdf6a5d809810f91579ee07d77ebcfd8c77b63659ac499fc8918b0f031d21856f59bdb21a6378d13fa
-  data.tar.gz: 9762b80efff32de7b69b757b2f20993d97c6e3ff2270c80e5e181cd1ab002425177221df849275d3d414244e743235c0fdf322c1f7f594de68816f7c16465637
+  metadata.gz: cf7b4edda75f282566b4f38c3e48c88f716056055734dae4bd2a08016e5d1e9d7d148922fc4ddcd5625fde5740376cb6e0088bf0c8a558c5d78e6e4723f84668
+  data.tar.gz: 3cdb10455d12dbc9f265ea500bccb965775e2d767ae8e798bea35a356ce8065036c0402e60016ff7feb2ea2de2198ea75b901592ac3c45993e3f55c953662ba7

data/CHANGELOG.md

@@ -1,41 +1,53 @@
-# 1.3.0
+# CHANGELOG
 
-* Set ruby version minimum requirement to 2.5.0
+## 1.3.2 (2026-07-25)
 
-# 1.2.0
+- BREAKING: Require Ruby 3.4 or newer
+- Fix `get_clients` to call `/1.1/:account_id/clients` instead of `/1.1/accounts`
+- Move `TimelyApp::Cli` under `lib/`
 
-* Fix version definition
+## 1.3.1 (2023-09-30)
 
-# 1.1.1
+- Refresh gemfile lock
 
-* Update gem configuration
+## 1.3.0 (2023-08-30)
 
-# 1.1.0
+- Set minimum ruby version requirement to 2.5.0
 
-* Update ruby version to 3.2.2
-* Update dependencies
+## 1.2.0 (2023-08-29)
 
-# 1.0.5
+- Fix version definition
 
-* Fix verbose mode check
+## 1.1.1 (2023-08-29)
 
-# 1.0.4
+- Update gem configuration
 
-* Update CLI to check input properly and handle command arguments
+## 1.1.0 (2023-08-15)
 
-# 1.0.3
+- Update ruby version to 3.2.2
+- Update dependencies
 
-* Fix gemspec
+## 1.0.5 (2023-03-02)
 
-# 1.0.2
+- Fix verbose mode check
 
-* Add basic CLI script `timely-app`
+## 1.0.4 (2023-02-14)
 
-# 1.0.1
+- Update CLI to check input properly and handle command arguments
 
-* Fix oauth token request
-* Add example web service for CLI authorization
+## 1.0.3 (2023-02-14)
 
-# 1.0.0
+- Fix gemspec
 
-* Initial version
+## 1.0.2 (2023-02-14)
+
+- Add basic CLI script `timely-app`
+
+## 1.0.1 (2023-02-14)
+
+- Fix oauth token request
+- Add example web service for CLI authorization
+
+## 1.0.0 (2023-02-14)
+
+- Initial version

data/README.md

@@ -1,19 +1,25 @@
 # timely-app
 
-[![Gem Version](https://badge.fury.io/rb/timely-app.svg)](https://badge.fury.io/rb/timely-app) [![Test Status](https://github.com/amkisko/timely-app/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/timely-app/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/timely_app.rb/graph/badge.svg?token=QL3A7ATCRK)](https://codecov.io/gh/amkisko/timely_app.rb)
+[![Gem Version](https://badge.fury.io/rb/timely-app.svg)](https://badge.fury.io/rb/timely-app) [![Test Status](https://github.com/amkisko/timely-app/actions/workflows/test.yml/badge.svg)](https://github.com/amkisko/timely-app/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/amkisko/timely_app.rb/graph/badge.svg?token=QL3A7ATCRK)](https://app.codecov.io/github/amkisko/timely_app.rb)
 
 Ruby client for the [Timely API](https://dev.timelyapp.com).
 
 Sponsored by [Kisko Labs](https://www.kiskolabs.com).
 
+<a href="https://www.kiskolabs.com">
+  <img src="kisko.svg" width="200" alt="Sponsored by Kisko Labs" />
+</a>
+
 ## Install
 
 Using Bundler:
+
 ```sh
 bundle add timely-app
 ```
 
 Using RubyGems:
+
 ```sh
 gem install timely-app
 ```
@@ -99,6 +105,19 @@ gem build timely-app.gemspec
 gem push timely-app-*.gem
 ```
 
+## Links
+
+- [GitHub](https://github.com/amkisko/timely_app.rb)
+- [GitLab](https://gitlab.com/amkisko/timely_app.rb)
+- [RubyGems](https://rubygems.org/gems/timely-app)
+- [Versions Atom](https://rubygems.org/gems/timely-app/versions.atom) (feed id `5816973660388`)
+- [libraries.io](https://libraries.io/rubygems/timely-app)
+- [Deps.dev](https://deps.dev/rubygems/timely-app)
+- [SonarCloud](https://sonarcloud.io/project/overview?id=amkisko_timely_app.rb)
+- [Snyk](https://snyk.io/test/github/amkisko/timely_app.rb)
+- [Codecov](https://app.codecov.io/github/amkisko/timely_app.rb)
+- [OpenSSF Scorecard](https://scorecard.dev/viewer/?uri=github.com/amkisko/timely_app.rb)
+
 ## License
 
 The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/bin/timely-app

@@ -4,121 +4,6 @@ require "yaml"
 require "optparse"
 require "timely-app"
 
-module TimelyApp
-  class CLI
-    attr_reader :options, :client
-
-    def initialize(options = {})
-      @options = options
-      @client = TimelyApp::Client.new(
-        access_token: options[:access_token] || fetch_access_token,
-        account_id: options[:account_id] || fetch_account_id,
-        verbose: options[:verbose]
-      )
-    end
-
-    def get_config(key)
-      read_config_file&.fetch(key, nil)
-    end
-
-    def set_config(key, value)
-      save_config_file(key => value)
-    end
-
-    def command_exists?(cmd)
-      return false if cmd.nil? || cmd.empty?
-
-      client.respond_to?(cmd)
-    end
-
-    def call(cmd, *args)
-      client.send(cmd, *args)
-    end
-
-    def auth(client_id, client_secret)
-      if !client_id || !client_secret
-        puts "Usage: timely-app auth CLIENT_ID CLIENT_SECRET"
-        exit 1
-      end
-
-      auth_client = TimelyApp::Client.new(verbose: options[:verbose])
-      auth_url = auth_client.get_oauth_authorize_url(
-        client_id: client_id,
-        redirect_uri: "urn:ietf:wg:oauth:2.0:oob"
-      )
-      puts "Visit this URL in your browser:"
-      puts auth_url
-      puts "\nEnter authorization code here:"
-      code = gets.chomp
-      begin
-        token = auth_client.post_oauth_token(
-          client_id: client_id,
-          client_secret: client_secret,
-          code: code,
-          redirect_uri: "urn:ietf:wg:oauth:2.0:oob",
-          grant_type: "authorization_code"
-        )
-        if options[:save]
-          save_config_file(
-            access_token: token.access_token,
-            refresh_token: token.refresh_token,
-            created_at: token.created_at
-          )
-        else
-          puts "\nAccess token:\n#{token.access_token}\n"
-        end
-        if options[:verbose]
-          puts "Token details: #{token.to_h}"
-        end
-      rescue TimelyApp::Error => e
-        puts "Authentication failed"
-        if options[:verbose]
-          puts "Code: #{code}"
-          puts "Response code: #{e.response.code}"
-          puts "Response: #{e.response.body}"
-        end
-        exit 1
-      end
-    end
-
-    private
-
-    def config_file_path
-      Dir.home + "/.timelyrc"
-    end
-
-    def read_config_file
-      if File.exist?(config_file_path)
-        YAML.load_file(config_file_path)
-      end
-    end
-
-    def fetch_account_id
-      read_config_file&.fetch("account_id", nil)
-    end
-
-    def fetch_access_token
-      read_config_file&.fetch("access_token", nil)
-    end
-
-    def check_access_token
-      if !fetch_access_token
-        puts "No access token found. Run `timely-app auth` to get one."
-        exit 1
-      end
-    end
-
-    def save_config_file(**options)
-      config = read_config_file || {}
-      config.merge!(options)
-      File.open(config_file_path, "w") do |f|
-        f.write(config.to_yaml)
-      end
-      puts "Saved to #{config_file_path}"
-    end
-  end
-end
-
 options = {}
 OptionParser.new do |opts|
   opts.banner = "Usage: timely-app [command] [options]"
@@ -141,8 +26,8 @@ cli = TimelyApp::CLI.new(options)
 cmd = ARGV.shift
 case cmd
 when "auth"
-  client_id = ARGV.shift || ENV.fetch('TIMELY_CLIENT_ID')
-  client_secret = ARGV.shift || ENV.fetch('TIMELY_CLIENT_SECRET')
+  client_id = ARGV.shift || ENV.fetch("TIMELY_CLIENT_ID")
+  client_secret = ARGV.shift || ENV.fetch("TIMELY_CLIENT_SECRET")
   ARGV.clear
   if client_id && client_secret
     cli.auth(client_id, client_secret)
@@ -161,7 +46,10 @@ when "config"
   end
 else
   if cli.command_exists?(cmd)
-    args = ARGV.reduce({}){ |h, arg| k, v = arg.split("="); h[k] = v; h }
+    args = ARGV.each_with_object({}) { |arg, h|
+      k, v = arg.split("=")
+      h[k] = v
+    }
     ARGV.clear
     response = cli.call(cmd, *args)
     case response

data/lib/timely-app/cli.rb

@@ -0,0 +1,132 @@
+module TimelyApp
+  class CLI
+    attr_reader :options, :client
+
+    def initialize(options = {})
+      @options = options
+      @client = TimelyApp::Client.new(
+        access_token: options[:access_token] || fetch_access_token,
+        account_id: options[:account_id] || fetch_account_id,
+        verbose: options[:verbose]
+      )
+    end
+
+    def get_config(key)
+      read_config_file&.fetch(key, nil)
+    end
+
+    def set_config(key, value)
+      save_config_file(key => value)
+    end
+
+    def command_exists?(cmd)
+      return false if cmd.nil? || cmd.empty?
+
+      client.respond_to?(cmd)
+    end
+
+    def call(cmd, *args)
+      client.send(cmd, *args)
+    end
+
+    def auth(client_id, client_secret)
+      validate_auth_credentials!(client_id, client_secret)
+
+      auth_client = TimelyApp::Client.new(verbose: options[:verbose])
+      code = authorize_via_browser(auth_client, client_id)
+      token = fetch_oauth_token(auth_client, client_id, client_secret, code)
+      persist_or_print_token(token)
+    rescue TimelyApp::Error => error
+      handle_auth_failure(error, code)
+    end
+
+    private
+
+    def validate_auth_credentials!(client_id, client_secret)
+      return if client_id && client_secret
+
+      puts "Usage: timely-app auth CLIENT_ID CLIENT_SECRET"
+      exit 1
+    end
+
+    def authorize_via_browser(auth_client, client_id)
+      auth_url = auth_client.get_oauth_authorize_url(
+        client_id: client_id,
+        redirect_uri: oauth_redirect_uri
+      )
+      puts "Visit this URL in your browser:"
+      puts auth_url
+      puts "\nEnter authorization code here:"
+      gets.chomp
+    end
+
+    def oauth_redirect_uri
+      "urn:ietf:wg:oauth:2.0:oob"
+    end
+
+    def fetch_oauth_token(auth_client, client_id, client_secret, code)
+      auth_client.post_oauth_token(
+        client_id: client_id,
+        client_secret: client_secret,
+        code: code,
+        redirect_uri: oauth_redirect_uri,
+        grant_type: "authorization_code"
+      )
+    end
+
+    def persist_or_print_token(token)
+      if options[:save]
+        save_config_file(
+          access_token: token.access_token,
+          refresh_token: token.refresh_token,
+          created_at: token.created_at
+        )
+      else
+        puts "\nAccess token:\n#{token.access_token}\n"
+      end
+      puts "Token details: #{token.to_h}" if options[:verbose]
+    end
+
+    def handle_auth_failure(error, code)
+      puts "Authentication failed"
+      if options[:verbose]
+        puts "Code: #{code}"
+        puts "Response code: #{error.response.code}"
+        puts "Response: #{error.response.body}"
+      end
+      exit 1
+    end
+
+    def config_file_path
+      Dir.home + "/.timelyrc"
+    end
+
+    def read_config_file
+      if File.exist?(config_file_path)
+        YAML.load_file(config_file_path)
+      end
+    end
+
+    def fetch_account_id
+      read_config_file&.fetch("account_id", nil)
+    end
+
+    def fetch_access_token
+      read_config_file&.fetch("access_token", nil)
+    end
+
+    def check_access_token
+      unless fetch_access_token
+        puts "No access token found. Run `timely-app auth` to get one."
+        exit 1
+      end
+    end
+
+    def save_config_file(**options)
+      config = read_config_file || {}
+      config.merge!(options)
+      File.write(config_file_path, config.to_yaml)
+      puts "Saved to #{config_file_path}"
+    end
+  end
+end

data/lib/timely-app/client/accounts.rb

@@ -4,7 +4,7 @@
 module TimelyApp
   class Client
     def get_accounts
-      get('/1.1/accounts')
+      get("/1.1/accounts")
     end
 
     def get_account_activities(account_id, **params)

data/lib/timely-app/client/auth.rb

@@ -6,7 +6,7 @@ module TimelyApp
     def get_oauth_authorize_url(client_id:, redirect_uri:)
       host_uri_join(
         "/1.1/oauth/authorize",
-        response_type: 'code',
+        response_type: "code",
         redirect_uri: redirect_uri,
         client_id: client_id
       )

data/lib/timely-app/client/clients.rb

@@ -8,7 +8,7 @@ module TimelyApp
     end
 
     def get_clients(**params)
-      get('/1.1/accounts', params)
+      get("/1.1/#{account_id}/clients", **params)
     end
 
     def get_client(id)

data/lib/timely-app/client.rb

@@ -1,29 +1,29 @@
 # frozen_string_literal: true
 
-require 'timely-app/errors'
-require 'timely-app/link_header'
-require 'timely-app/params'
-require 'timely-app/record'
-require 'timely-app/response'
-require 'net/http'
-require 'json'
+require "timely-app/errors"
+require "timely-app/link_header"
+require "timely-app/params"
+require "timely-app/record"
+require "timely-app/response"
+require "net/http"
+require "json"
 
 module TimelyApp
   class Client
     attr_accessor :account_id
 
     def initialize(options = {})
-      @auth_header = 'Authorization'
+      @auth_header = "Authorization"
       @auth_value = "Bearer #{options[:access_token]}"
       @user_agent = options.fetch(:user_agent) { "timely-app/#{VERSION} ruby/#{RUBY_VERSION}" }
 
-      @host = 'api.timelyapp.com'
+      @host = "api.timelyapp.com"
 
       @http = Net::HTTP.new(@host, Net::HTTP.https_default_port)
       @http.use_ssl = true
 
       @account_id = options[:account_id]
-      @verbose = options[:verbose] || !ENV['VERBOSE'].nil? || false
+      @verbose = options[:verbose] || !ENV["VERBOSE"].nil? || false
     end
 
     def get(path, params = nil)
@@ -37,7 +37,7 @@ module TimelyApp
     end
 
     def host_uri_join(path, params)
-      URI::join("https://#{@host}", Params.join(path, params)).to_s
+      URI.join("https://#{@host}", Params.join(path, params)).to_s
     end
 
     def post(path, attributes)
@@ -53,24 +53,29 @@ module TimelyApp
     end
 
     def request(http_request, body_object = nil)
-      http_request['User-Agent'] = @user_agent
-      http_request[@auth_header] = @auth_value
+      apply_request_headers(http_request, body_object)
+      response = @http.request(http_request)
+      log_verbose_exchange(http_request, response)
+      raise Response.error(response) unless response.is_a?(Net::HTTPSuccess)
 
-      if body_object
-        http_request['Content-Type'] = 'application/json'
-        http_request.body = JSON.generate(body_object)
-      end
+      Response.parse(response)
+    end
 
-      response = @http.request(http_request)
+    def apply_request_headers(http_request, body_object)
+      http_request["User-Agent"] = @user_agent
+      http_request[@auth_header] = @auth_value
 
-      if verbose?
-        puts ">> request: #{http_request.method} #{http_request.path} #{http_request.body}"
-        puts "<< response: #{http_request.method} #{http_request.path} #{response.code} #{response.body}"
-      end
+      return unless body_object
 
-      raise Response.error(response) unless response.is_a?(Net::HTTPSuccess)
+      http_request["Content-Type"] = "application/json"
+      http_request.body = JSON.generate(body_object)
+    end
 
-      Response.parse(response)
+    def log_verbose_exchange(http_request, response)
+      return unless verbose?
+
+      puts ">> request: #{http_request.method} #{http_request.path} #{http_request.body}"
+      puts "<< response: #{http_request.method} #{http_request.path} #{response.code} #{response.body}"
     end
   end
 end

data/lib/timely-app/errors.rb

@@ -16,6 +16,6 @@ module TimelyApp
 
   UnauthorizedError = Class.new(ClientError)
 
-  NotFound = Class.new(ClientError)
+  NotFoundError = Class.new(ClientError)
   ForbiddenError = Class.new(ClientError)
 end

data/lib/timely-app/link_header.rb

@@ -1,5 +1,5 @@
-require 'timely-app/record'
-require 'uri'
+require "timely-app/record"
+require "uri"
 
 module TimelyApp
   module LinkHeader

data/lib/timely-app/params.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
-require 'cgi'
+
+require "cgi"
 
 module TimelyApp
   module Params
@@ -8,17 +9,17 @@ module TimelyApp
     def join(path, params = nil)
       return path if params.nil? || params.empty?
 
-      path + '?' + encode(params)
+      path + "?" + encode(params)
     end
 
     def encode(params)
-      params.map { |k, v| "#{escape(k)}=#{array_escape(v)}" }.join('&')
+      params.map { |k, v| "#{escape(k)}=#{array_escape(v)}" }.join("&")
     end
 
     private
 
     def array_escape(object)
-      Array(object).map { |value| escape(value) }.join(',')
+      Array(object).map { |value| escape(value) }.join(",")
     end
 
     def escape(component)

data/lib/timely-app/record.rb

@@ -14,13 +14,13 @@ module TimelyApp
 
     def method_missing(name, *args, &block)
       if @attributes.has_key?(name) && args.empty? && block.nil?
-        return @attributes[name]
+        @attributes[name]
       else
-        super name, *args, &block
+        super
       end
     end
 
-    def respond_to_missing?(name, include_private = false)
+    def respond_to_missing?(name, _include_private = false)
       @attributes.has_key?(name)
     end
 

data/lib/timely-app/response.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
-require 'net/http'
-require 'json'
+
+require "net/http"
+require "json"
 
 module TimelyApp
   module Response
@@ -11,12 +12,12 @@ module TimelyApp
         return :no_content
       end
 
-      if response.content_type == 'application/json'
+      if response.content_type == "application/json"
         object = JSON.parse(response.body, symbolize_names: true, object_class: Record)
 
-        if response['Link']
+        if response["Link"]
           object.singleton_class.module_eval { attr_accessor :link }
-          object.link = LinkHeader.parse(response['Link'])
+          object.link = LinkHeader.parse(response["Link"])
         end
 
         return object

data/lib/timely-app.rb

@@ -1,19 +1,19 @@
-require 'timely-app/client'
-require 'timely-app/client/accounts'
-require 'timely-app/client/auth'
-require 'timely-app/client/clients'
-require 'timely-app/client/events'
-require 'timely-app/client/forecasts'
-require 'timely-app/client/labels'
-require 'timely-app/client/permissions'
-require 'timely-app/client/projects'
-require 'timely-app/client/reports'
-require 'timely-app/client/roles'
-require 'timely-app/client/teams'
-require 'timely-app/client/user_capacities'
-require 'timely-app/client/users'
-require 'timely-app/client/webhooks'
+require "timely-app/client"
+require "timely-app/client/accounts"
+require "timely-app/client/auth"
+require "timely-app/client/clients"
+require "timely-app/client/events"
+require "timely-app/client/forecasts"
+require "timely-app/client/labels"
+require "timely-app/client/permissions"
+require "timely-app/client/projects"
+require "timely-app/client/reports"
+require "timely-app/client/roles"
+require "timely-app/client/teams"
+require "timely-app/client/user_capacities"
+require "timely-app/client/users"
+require "timely-app/client/webhooks"
 
 module TimelyApp
-  VERSION = '1.3.0'
+  VERSION = "1.3.2"
 end