esi 0.4.21 → 0.4.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6445f97d24e7c39a1d2535a380d48fdd9f7cc8a02478620be5eeb855bfebbf3a
-  data.tar.gz: 53fa4257ead7a3c273e377dbcc190a1bfa488ad97ce8fbfe39865d1b448296a7
+  metadata.gz: 123d405531560b767184c3892d28e5f9805e442c05d4728cf74e9c085145ade3
+  data.tar.gz: 7d5d5ae42b9aa16a2d45c067c9372112319c2e83928a065757d79176b157b2a0
 SHA512:
-  metadata.gz: 60e70596309b79ce570982348162f968c803067f448707ad0b8bd8476f50d162a29b8debaa37efbbc76b6043b98467ab980c54a0e88706f20c9a9369862708b4
-  data.tar.gz: 0a2ec295ee089fc160132eaee458b95add0b0b902ed78756a6512a1da0873f6279fabf86025fb7978e8c2c6457ff25a63a8d49eea065456b9f669ab1b47fee29
+  metadata.gz: 2475204c9c2002eec3b323ca1d682a9cb5af98aed1ccdabfd9f21c587749cece51f451e094ba04a6113f87906b170aced227654055662d60ad52e9182f9dc7f2
+  data.tar.gz: ebf4e296a46f87a060a7f75c4dce35f1c05bede58dd5da0a7b9ab2eaa61a4a7dc2f4d29a826c4719f50407e08f1d2593c09500866fc693c873a01444b2677337

data/README.md

@@ -1,5 +1,5 @@
 # Esi
-
+[![Gem Version](https://badge.fury.io/rb/esi.svg)](https://badge.fury.io/rb/esi)
 [![TravisCI build status](https://travis-ci.org/dhiemstra/esi.svg?branch=master)](https://travis-ci.org/dhiemstra/esi)
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/esi`. To experiment with that code, run `bin/console` for an interactive prompt.
@@ -41,26 +41,12 @@ Add your client id and secret in an initializer or so.
     Esi.config.client_id = 'APP_CLIENT_ID'
     Esi.config.client_secret = 'APP_CLIENT_SECRET'
 
-## Configuration
-
-Create a file `config/initializers/esi.rb` with the following options:
-
-    # Specify a custom log level
-    Esi.config.log_level = :debug
-
-    # Specify a custom log path
-    Esi.config.log_target = Rails.root.join('log', 'esi.log')
-
-    # Specify a custom logger
-    Esi.config.logger = Rails.logger
-
-    # Set esi api version to dev
-    Esi.config.api_version = :dev
+## Configuration in Rails
 
-    # Save all raw JSON responses in this folder
-    Esi.config.response_log_path = Rails.root.join('tmp', 'esi')
+Install the initializer with `rails generator esi:install` and modify
+`config/initializers/esi.rb`.
 
-# Caching
+### Caching
 
 ESI will cache API requests that auto expire based on the `Expires-At` header returned by ESI. By default [`ActiveSupport::Cache::MemoryStore`](http://api.rubyonrails.org/classes/ActiveSupport/Cache/MemoryStore.html) is used. When using Rails you can configure ESI to use the cache configured in your app by setting the `cache` config variable.
 

data/esi.gemspec

@@ -21,10 +21,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency 'activesupport'
   spec.add_dependency 'addressable', '~> 2.3'
   spec.add_dependency 'oauth2', '~> 1.4'
+  spec.add_dependency 'railties', '~> 5.1'
   spec.add_development_dependency 'bundler', '~> 1.14'
   spec.add_development_dependency 'minitest', '~> 5.0'
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rubocop', '~> 0.52'
   spec.add_development_dependency 'shoulda', '~> 3.5'
+  spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'yard', '~> 0.9'
 end

data/lib/esi/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Esi
-  VERSION = '0.4.21'
+  VERSION = '0.4.22'
 end

data/lib/generators/esi/install_generator.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+require 'rails/generators'
+require 'rails/generators/active_record'
+
+# The Esi generator module
+# @private
+module Esi
+  # Rails ESI Install Generator
+  # @author Aaron Allen <hello@aaronmallen.me>
+  # @version 0.1
+  # @since 0.4.21
+  # @private
+  class InstallGenerator < ::Rails::Generators::Base
+    include ::Rails::Generators::Migration
+    source_root File.expand_path('templates', __dir__)
+    desc 'Installs Esi.'
+
+    # Called by rails generate
+    # Installs esi.rb in config/initializers and
+    # prints a helpful guide for next steps.
+    def install
+      template 'initializer.rb', 'config/initializers/esi.rb'
+    end
+  end
+end

data/lib/generators/esi/templates/initializer.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+# Specify a custom log level
+Esi.config.log_level = :info
+
+# Specify a custom log path
+Esi.config.log_target = Rails.root.join('log', 'esi.log')
+
+# Specify a custom logger
+Esi.config.logger = Rails.logger
+
+# Set esi api version to dev
+Esi.config.api_version = :latest
+
+# Save all raw JSON responses in this folder
+Esi.config.response_log_path = Rails.root.join('tmp', 'esi')
+
+# Set Esi Cache to Rails.cache
+Esi.config.cache = Rails.cache
+
+# Set Esi Client Id
+Esi.config.client_id = ENV['ESI_CLIENT_ID']
+
+# Set Esi Client Secret
+Esi.config.client_secret = ENV['ESI_CLIENT_SECRET']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: esi
 version: !ruby/object:Gem::Version
-  version: 0.4.21
+  version: 0.4.22
 platform: ruby
 authors:
 - Danny Hiemstra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-05-06 00:00:00.000000000 Z
+date: 2018-05-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.4'
+- !ruby/object:Gem::Dependency
+  name: railties
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.1'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -123,6 +137,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.16'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
@@ -173,6 +201,8 @@ files:
 - lib/esi/o_auth.rb
 - lib/esi/response.rb
 - lib/esi/version.rb
+- lib/generators/esi/install_generator.rb
+- lib/generators/esi/templates/initializer.rb
 - lib/omniauth/esi.rb
 - lib/omniauth/strategies/esi.rb
 homepage: https://github.com/dhiemstra/esi