timely-app 1.0.0 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6e93ac9511c215489f329d2a464a85ee094ddadb88b41710298fd6e7aeca1d48
-  data.tar.gz: '0888c32a76cfabc24b32a74c5745f5fdc0252b2a9e28d395cadc6888eb52b1c9'
+  metadata.gz: 7742cc26953cb2a3549c474090533399801ccc4a73fc9edd9bd0576bb2043729
+  data.tar.gz: 7905082d94868140a43621a4ee5ae06b43c329895c1d5aa60079224daba8e97b
 SHA512:
-  metadata.gz: 765f0d5cd8a1bdbdbb84b4d22cc60702d61547e4de445d13ac76d1b642cca88a82d9478e83566a75c1ba14bd021c8bc717fb4e5042b1c734480f3199da37b98f
-  data.tar.gz: 8003b4a414f1b39a828fdfa3434d50a6f803bdc9c0a181ed4a544e131c44131ff3bc9836508c522d776fd2c767105e87dc8ff520d968a1af5862efd00c32dd3a
+  metadata.gz: 3d78140e011964c68cf77a4850e9e2cb7a5e24de3253009f84bfa4dcee97fbf3c49abd5f5f5cbbbed33419630981706ecdb4fae9abb99a801b979769e3ffee58
+  data.tar.gz: ef2358800b0b3a5aacafa57a7a5863fd408f402b516cb88f203d29c0b02172325e8c47913176b27c1b1bff47d975feb1f19d13b3d7ebc3edebdfe6dbc04b8628

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 1.0.1
+
+* Fix oauth token request
+* Add example web service for CLI authorization
+
 # 1.0.0
 
 * Initial version

data/README.md

@@ -16,7 +16,19 @@ Using RubyGems:
 gem install timely-app
 ```
 
-## Getting started
+## Usage for CLI
+
+Register your local service at https://app.timelyapp.com/{account_id}/oauth_applications
+
+Run auth script:
+
+```sh
+TIMELY_CLIENT_ID=<CLIENT_ID> TIMELY_CLIENT_SECRET=<CLIENT_SECRET> ./examples/auth_cli.rb
+```
+
+## Usage for web service
+
+Example web server: `./examples/auth_server.rb`
 
 Implement link to Timely OAuth authorization page:
 
@@ -24,34 +36,34 @@ Implement link to Timely OAuth authorization page:
 <%= link_to "Sign in with Timely", TimelyApp::Client.new.get_oauth_authorize_url(client_id: ENV.fetch("TIMELY_CLIENT_ID"), redirect_uri: ENV.fetch("TIMELY_REDIRECT_URI")) %>
 ```
 
-Implement callback action to get access token:
+Implement callback action to get access token (devise example):
 
 ```ruby
-  def timely_auth_callback
-    skip_verify_authorized!
+def timely_auth_callback
+  skip_verify_authorized!
 
-    client = TimelyApp::Client.new
-    token = client.post_oauth_token(client_id: ENV.fetch("TIMELY_CLIENT_ID"), client_secret: ENV.fetch("TIMELY_CLIENT_SECRET"), code: params["code"], redirect_uri: ENV.fetch("TIMELY_REDIRECT_URI"), grant_type: "authorization_code")
+  client = TimelyApp::Client.new
+  token = client.post_oauth_token(client_id: ENV.fetch("TIMELY_CLIENT_ID"), client_secret: ENV.fetch("TIMELY_CLIENT_SECRET"), code: params["code"], redirect_uri: ENV.fetch("TIMELY_REDIRECT_URI"), grant_type: "authorization_code")
 
-    if token["access_token"].present?
-      client.access_token = token["access_token"]
-      timely_user = client.get_current_user
+  if token["access_token"].present?
+    client.access_token = token["access_token"]
+    timely_user = client.get_current_user
 
-      user = User.find_or_create_by(email: timely_user["email"])
-      user.update!(timely_id: timely_user["id"], timely_access_token: token["access_token"], timely_refresh_token: token["refresh_token"])
+    user = User.find_or_create_by(email: timely_user["email"])
+    user.update!(timely_id: timely_user["id"], timely_access_token: token["access_token"], timely_refresh_token: token["refresh_token"])
 
-      sign_in(user)
+    sign_in(user)
 
-      redirect_to "/authorized"
-    else
-      redirect_to "/not-authorized"
-    end
-  rescue TimelyApp::Error => _e
+    redirect_to "/authorized"
+  else
     redirect_to "/not-authorized"
   end
+rescue TimelyApp::Error => _e
+  redirect_to "/not-authorized"
+end
 ```
 
-Use client:
+## Client usage
 
 ```ruby
 timely = TimelyApp::Client.new(access_token: <USER_TOKEN_AFTER_OAUTH>, account_id: <ACCOUNT_ID>)

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

@@ -13,13 +13,14 @@ module TimelyApp
     end
 
     def post_oauth_token(client_id:, client_secret:, code:, redirect_uri:, grant_type: "authorization_code")
-      post("/1.1/oauth/token", body: {
+      post(
+        "/1.1/oauth/token",
         redirect_uri: redirect_uri,
         code: code,
         client_id: client_id,
         client_secret: client_secret,
         grant_type: grant_type
-      }, params: {})
+      )
     end
   end
 end

data/lib/timely-app/client.rb

@@ -57,6 +57,11 @@ module TimelyApp
 
       response = @http.request(http_request)
 
+      if ENV["DEBUG"]
+        puts ">> request: #{http_request.method} #{http_request.path} #{http_request.body}"
+        puts "<< response: #{http_request.method} #{http_request.path} #{response.code} #{response.body}"
+      end
+
       if response.is_a?(Net::HTTPSuccess)
         Response.parse(response)
       else

data/lib/timely-app/response.rb

@@ -28,7 +28,8 @@ module TimelyApp
     def error(response)
       if response.content_type == "application/json"
         body = JSON.parse(response.body)
-        error_class(response).new(body&.dig("errors", "message"), response: response, errors: body&.dig("errors"))
+        message = body&.dig("errors", "message") || body&.dig("error_description")
+        error_class(response).new(message, response: response, errors: body&.dig("errors"))
       else
         error_class(response).new(response: response)
       end

data/lib/timely-app/version.rb

@@ -1,3 +1,3 @@
 module TimelyApp
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/timely-app.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |s|
   s.name = 'timely-app'
-  s.version = '1.0.0'
+  s.version = '1.0.1'
   s.license = 'MIT'
   s.platform = Gem::Platform::RUBY
   s.authors = ['Andrei Makarov']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: timely-app
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
 platform: ruby
 authors:
 - Andrei Makarov