tito_ruby 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 73cbde370966ff7bd4126f3d3fddd9b9fa4efd3a891b777cbc7374abff3c5c91
-  data.tar.gz: 59c29faa752f290d6a24dc7e1b3b84fc83387eb21cf2194078cc5c02505b6e19
+  metadata.gz: d5aff44c4d4d1c7ba8d35c33db508172e27763bcc264498c320b7924fd04c2e5
+  data.tar.gz: 9c7b0dd2172f7fd5d1e42ac48169f0c273421ba2ff7e798e37195cc54301ff98
 SHA512:
-  metadata.gz: 9facfcdc3beb4fc65845be8770ef7dc3734dd3d5f946d3da52d8a7ea92a436da0afdd2f45f5f751fb5b38a45dcff2fee58a978b905fc9fb7a9102bf16d553b31
-  data.tar.gz: 7cadc85147c5319f7f23a6bc0fe097af3a6ce8a3b08bd46c67852268ddeb770f5d5ec9de61a224d1f9493124de3f75350da5c267d6f002b721c58b759f7f14bf
+  metadata.gz: 22b86e2c5069e40e5062f456f42fd702a30dba9cf6fda7df5b4e4b832c14195ba3d002bcbaedb6c9effabf3e3978f11a39a7db6ebbbc7b534dc468b80adfa91d
+  data.tar.gz: 79332e529d1f7f557f433146e0bf3883be3603c47d5370c9295c4b6bd1e6b4c00e4dbd7dd9ce675849dbdca3340940d28376392a666ab330eb1b2b8bf91d2733

data/CHANGELOG.md

@@ -1,6 +1,13 @@
 # Changelog
 
-## 0.2.0 (Unreleased)
+## 0.3.0 (Unreleased)
+
+- Added request logging via Faraday's built-in logger middleware
+- Added `Tito.logger` / `Tito.logger=` for easy logger configuration
+- Added Rails Railtie that auto-sets `Tito.logger = Rails.logger`
+- Fixed QueryBuilder array params adding an extra `[]` suffix (e.g. `where(state: ["complete"])` now sends correctly)
+
+## 0.2.0
 
 - Updated all resource definitions to match actual Tito API v3 responses
 - Fixed Resource to silently drop unknown attributes from API responses instead of crashing

data/README.md

@@ -122,6 +122,33 @@ client.tickets
 
 :white_check_mark: = tested against live API  :grey_question: = implemented but untested  :x: = known broken
 
+## Logging
+
+In a Rails app, request logging is enabled automatically via `Rails.logger`. You'll see output like:
+
+```
+request: GET https://api.tito.io/v3/letterblock/test-event-1/tickets?page%5Bnumber%5D=1
+response: Status 200
+```
+
+Outside of Rails, set a logger manually:
+
+```ruby
+Tito.logger = Logger.new(STDOUT)
+```
+
+Or via the configure block:
+
+```ruby
+Tito.configure do |config|
+  config.logger = Logger.new(STDOUT)
+end
+```
+
+This uses Faraday's built-in logger middleware, omitting headers and bodies. Set `Tito.logger = nil` to disable.
+
+Note: the logger is captured when the first request is made on a client. If you set `Tito.logger` after a client has already been used, create a new client for it to take effect.
+
 ## Development
 
 ```

data/lib/tito/admin/query_builder.rb

@@ -73,7 +73,7 @@ module Tito
           when Array
             plural_key = key.to_s
             plural_key = plural_key.end_with?("s") ? plural_key : "#{plural_key}s"
-            params["search[#{plural_key}][]"] = value.map(&:to_s)
+            params["search[#{plural_key}]"] = value.map(&:to_s)
           when Range
             if value.begin
               params["search[#{key}][gte]"] = format_value(value.begin)

data/lib/tito/configuration.rb

@@ -1,6 +1,6 @@
 module Tito
   class Configuration
-    attr_accessor :token, :account, :base_url
+    attr_accessor :token, :account, :base_url, :logger
 
     def initialize
       @base_url = "https://api.tito.io/v3"

data/lib/tito/connection.rb

@@ -28,6 +28,7 @@ module Tito
         f.headers["Authorization"] = "Token token=#{@token}"
         f.headers["Accept"] = "application/json"
         f.request :json
+        f.response :logger, Tito.logger, headers: false, bodies: false if Tito.logger
         f.response :json, content_type: /\bjson$/
       end
     end

data/lib/tito/railtie.rb

@@ -0,0 +1,7 @@
+module Tito
+  class Railtie < Rails::Railtie
+    initializer "tito.logger" do
+      Tito.logger = Rails.logger
+    end
+  end
+end

data/lib/tito/version.rb

@@ -1,3 +1,3 @@
 module Tito
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/lib/tito.rb

@@ -51,12 +51,22 @@ module Tito
       @configuration ||= Configuration.new
     end
 
+    def logger
+      configuration.logger
+    end
+
+    def logger=(logger)
+      configuration.logger = logger
+    end
+
     def reset_configuration!
       @configuration = Configuration.new
     end
   end
 end
 
+require "tito/railtie" if defined?(Rails::Railtie)
+
 # Register custom types
 ActiveModel::Type.register(:string_array, Tito::Types::StringArray)
 ActiveModel::Type.register(:integer_array, Tito::Types::IntegerArray)

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: tito_ruby
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Joshua Paine
@@ -147,6 +147,7 @@ files:
 - lib/tito/configuration.rb
 - lib/tito/connection.rb
 - lib/tito/errors.rb
+- lib/tito/railtie.rb
 - lib/tito/resource.rb
 - lib/tito/types/integer_array.rb
 - lib/tito/types/json.rb