pokey 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 902eedd7df7d24c0ba7371ab75ed91dc59d1bf3f
-  data.tar.gz: 153fd390ac187d01c62b426bdda0c360925aa6f7
+  metadata.gz: 1fdaf56b0fdd1c671eb53bfc977869c3e2d69bd0
+  data.tar.gz: d44fe9670c6768ecdb1243324984f7133b337c53
 SHA512:
-  metadata.gz: 81d59aeed034302148895a9c828ec20c4958bf7316db5568a88c4baf8ce250fb98cb23022459f85c639f30b7736f714a2700aafdccfc370753d221eb420c647d
-  data.tar.gz: b93105e18878dc227d46cb478f8f60775373f041aac5afb66ca270a6be01bb8473d174134607a952e2d79b0a89d00e1117491cf090a89237c63ae07e04f43ecb
+  metadata.gz: 82fcb403c1bd62b1a9d58dfb87a188ff1a01215f7fd4a1a7072e197590c1b8e3ee4c53ccfa7a2b9c9b942e2de451702389fbceca4a7691df0ccc0080a75ed137
+  data.tar.gz: dc43a6c15adca297a6a676cfe5a549824d261d71aaa3f2214edc9dedbaad5972261ef417099a40d801c7ef435c813bb26bc7016f65c0d264f9a3f41145976cf1

data/README.md

@@ -1,5 +1,7 @@
 # Pokey
 
+[![Gem Version](https://badge.fury.io/rb/pokey.svg)](http://badge.fury.io/rb/pokey) [![Code Climate](https://codeclimate.com/github/ccallebs/pokey/badges/gpa.svg)](https://codeclimate.com/github/ccallebs/pokey)
+
 Pokey is a Ruby gem designed to easily simulate webhooks / other HTTP requests common 
 to a production environment.
 
@@ -21,35 +23,40 @@ Or install it yourself as:
 
 ## Usage
 
-Create a new file in your initializers directory named `pokey.rb`. Here
-is where you'll be defining your API calls.
+If you're using Rails, create the initializer by running:
+
+    $ rails g pokey:install
+
+Otherwise, create a new file in your initializers directory named `pokey.rb`. You'll be
+setting the default hook directory and (optionally) defining custom hooks here.
 
 ``` RUBY
 Pokey.configure do |config|
+  config.hook_dir = "app/pokey" # Defaults to app/pokey
+  config.run_on = [:development, :qa] # Only set environments you want pokey to
+                                      # simulate requests for. If not using Rails,
+                                      # this currently has no effect
+
   config.add_hook do |hook|
     hook.destination = "/my/webhook/endpoint"
     hook.data = {
       name: "Test endpoint",
       endpoint_id: 1
     }
+    hook.interval = 20 # in seconds
+    hook.http_method = :post # supports GET and POST for right now
   end
-
-  Pokey::Scheduler.commit! # This isn't necessary in the config block
-                           # but is a decent enough place to put it. This
-                           # signifies that all endpoints have been added
-                           # and Rufus will begin to schedule hooks.
 end
 ```
 
-In addition, you can also define classes inside a designated directory to
-streamline creation of Pokey events.
+If you would like to add many hooks to your project, you can place them in the `hook_dir`
+you specified in the initializer. If you're using Rails, you can run
 
-``` RUBY
-# initializers/pokey.rb
-Pokey.configure do |config|
-  config.hook_dir = "app/pokey" # Defaults to app/pokey
-end
+    $ rails g pokey:hook sendgrid_event
+
+to create a new `Pokey::Hook` template. Otherwise, create a file like the following:
 
+``` RUBY
 # app/pokey/sendgrid_event_hook.rb
 class SendgridEventHook < Pokey::Hook
   def destination
@@ -111,7 +118,7 @@ end
 ```
 
 As your data will inevitably get more complex to simulate actual events,
-Pokey::Hook sub-classes are the preferred way to declare endpoints.
+`Pokey::Hook` subclasses are preferred over ad-hoc hook definitions.
 
 
 ## Contributing

data/lib/generators/rails/hook/hook_generator.rb

@@ -0,0 +1,16 @@
+require 'rails/generators'
+
+module Pokey
+  module Generators
+    class HookGenerator < Rails::Generators::NamedBase
+      desc "Generates a Pokey hook"
+      check_class_collision suffix: "Hook"
+
+      source_root File.expand_path("../templates", __FILE__)
+
+      def create_hook_file
+        template "hook.rb", "#{Pokey.hook_dir}/#{file_path.tr('/', '_')}_hook.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails/hook/templates/hook.rb

@@ -0,0 +1,13 @@
+class <%= class_name %>Hook < Pokey::Hook
+  def destination
+  end
+
+  def data
+  end
+
+  def interval
+  end
+
+  def http_method
+  end
+end

data/lib/generators/rails/install/install_generator.rb

@@ -0,0 +1,13 @@
+require 'rails/generators'
+
+module Pokey
+  module Generators
+    class InstallGenerator < Rails::Generators::Base
+      source_root File.expand_path("../templates", __FILE__)
+
+      def copy_initializer
+        template "initializer.rb.erb", "config/initializers/pokey.rb"
+      end
+    end
+  end
+end

data/lib/generators/rails/install/templates/initializer.rb.erb

@@ -0,0 +1,17 @@
+Pokey.configure do |config|
+  config.hook_dir = "app/hooks"
+  
+  config.run_on   = [:development, :qa] # Only set environments you want pokey
+                                        # to simulate requests for
+
+  # Add some hooks on-the-fly here. If your data is somewhat complicated, add
+  # a hook instead with `rails g pokey:hook hook_name`
+  # config.add_hook do |hook|
+  #   hook.destination = "/my/webhook/endpoint"
+  #   hook.data = {
+  #     name: "Test endpoint"
+  #   }
+  #   hook.interval = 120 # in seconds
+  #   hook.http_method = :post
+  # end
+end

data/lib/pokey.rb

@@ -2,15 +2,22 @@ require "pokey/version"
 require "pokey/configuration"
 require "pokey/hook"
 require "pokey/hooks"
+require "pokey/logger"
 require "pokey/request"
 require "pokey/scheduler"
 
+if defined?(Rails)
+  require "generators/rails/install/install_generator"
+  require "generators/rails/hook/hook_generator"
+end
+
 module Pokey
   class << self
     attr_writer :configuration
 
     def configure
       yield(configuration)
+      Pokey::Scheduler.run! if should_run?
     end
 
     def configuration
@@ -24,5 +31,15 @@ module Pokey
     def hook_dir
       configuration.hook_dir
     end
+
+    def should_run?
+      current_env.nil? || configuration.run_on.map(&:to_s).include?(current_env)
+    end
+
+    def current_env
+      if defined?(Rails)
+        Rails.env
+      end
+    end
   end
 end

data/lib/pokey/configuration.rb

@@ -1,9 +1,10 @@
 class Pokey::Configuration
-  attr_accessor :hook_dir, :hooks
+  attr_accessor :hook_dir, :hooks, :run_on
 
   def initialize
     @hook_dir = "app/pokey"
     @hooks = []
+    @run_on = [:development]
   end
 
   def add_hook(&block)

data/lib/pokey/hooks.rb

@@ -26,14 +26,6 @@ class Pokey::Hooks
     @@hooks << klass.new
   end
 
-  def self.add_from_file(file_path)
-    require file_path
-    
-    base_name = File.basename(file_path, ".rb")
-    klass = Helpers::Inflector.constantize(base_name.split('_').collect(&:capitalize).join) 
-    add_from_class(klass)
-  end
-
   def self.add_from_dir(directory)
     directory += "/" if directory[-1] != "/"
 

data/lib/pokey/logger.rb

@@ -0,0 +1,12 @@
+require 'logging'
+
+Logging.logger.root.appenders = Logging.appenders.stdout
+Logging.logger.root.level = :info
+
+class Pokey::Logger
+  attr_reader :log
+
+  def initialize
+    @log = Logging.logger[self]
+  end
+end

data/lib/pokey/request.rb

@@ -7,6 +7,7 @@ class Pokey::Request
 
   def initialize(destination, http_method = :post, data = {})
     @destination, @http_method, @data = destination, http_method, data
+    @log = Pokey::Logger.new.log
   end
 
   def raw_request
@@ -22,6 +23,10 @@ class Pokey::Request
       end
 
       response = http.request(request)
+
+      if response
+        @log.info "Made request to #{uri.host}:#{uri.port} with following data: #{@data}"
+      end
     end 
   end
 

data/lib/pokey/scheduler.rb

@@ -5,7 +5,7 @@ class Pokey::Scheduler
     @rufus ||= Rufus::Scheduler.new
   end
 
-  def self.commit!
+  def self.run!
     scheduler = new
 
     Pokey::Hooks.add_from_dir(Pokey.hook_dir)

data/lib/pokey/version.rb

@@ -1,3 +1,3 @@
 module Pokey
-  VERSION = "0.1.0".freeze
+  VERSION = "0.2.0".freeze
 end

data/pokey.gemspec

@@ -16,6 +16,7 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
 
   spec.add_runtime_dependency 'rufus-scheduler', '~> 3.1.2'
+  spec.add_runtime_dependency 'logging'
 
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"

data/spec/pokey/configure_spec.rb

@@ -35,4 +35,38 @@ describe Pokey do
       end
     end
   end
+
+  describe "#should_run?" do
+    context "when configured for current Rails.env" do
+      before do
+        allow(Pokey).to receive(:current_env).and_return("development")
+
+        Pokey.configure do |config|
+          config.run_on = [:development, :qa]
+        end
+      end
+
+      subject { Pokey.should_run? }
+
+      it "returns true" do
+        expect(subject).to eq true
+      end
+    end
+
+    context "when not configured for current Rails.env" do
+      before do
+        allow(Pokey).to receive(:current_env).and_return("production")
+
+        Pokey.configure do |config|
+          config.run_on = [:development, :qa]
+        end
+      end
+
+      subject { Pokey.should_run? }
+
+      it "returns false" do
+        expect(subject).to eq false
+      end
+    end
+  end
 end

data/spec/pokey/hooks_spec.rb

@@ -31,18 +31,6 @@ RSpec.describe Pokey::Hooks do
     end
   end
 
-  describe '.add_from_file' do
-    let(:file) { './spec/pokey/sample_hooks/sample_hook.rb' }
-
-    let(:subject) do
-      Pokey::Hooks.add_from_file(file)
-    end
-
-    it 'successfully adds hook to list' do
-      expect { subject }.to change { Pokey::Hooks.all.length }.by(1)
-    end
-  end
-
   describe '.add_from_dir' do
     let(:dir) { './spec/pokey/sample_hooks/' }
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pokey
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chuck Callebs
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-08-09 00:00:00.000000000 Z
+date: 2015-08-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rufus-scheduler
@@ -24,6 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.1.2
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
@@ -111,11 +125,16 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
+- lib/generators/rails/hook/hook_generator.rb
+- lib/generators/rails/hook/templates/hook.rb
+- lib/generators/rails/install/install_generator.rb
+- lib/generators/rails/install/templates/initializer.rb.erb
 - lib/pokey.rb
 - lib/pokey/configuration.rb
 - lib/pokey/helpers/inflector.rb
 - lib/pokey/hook.rb
 - lib/pokey/hooks.rb
+- lib/pokey/logger.rb
 - lib/pokey/request.rb
 - lib/pokey/scheduler.rb
 - lib/pokey/version.rb