prospector 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9a26aca5cebe6252d5c7669e2a4623159a621460
-  data.tar.gz: ba58266396be640a87b4bc86a9b1847df075d879
+  metadata.gz: 0eb069f50cbc32b8783bbc6a11a63f819859a12f
+  data.tar.gz: f82b2042f9f51fcdef5d19d7ab5b260d915659ec
 SHA512:
-  metadata.gz: 94dd515c0dcc1f5f9cab83eb674ce9bcc51145ed270751b3ec092efa114d40a04e0db7d271838355ccc794fc5c88ad9dde88be3d5c83b140a1d974067899c2b3
-  data.tar.gz: b3f3f8ca2c91c3416aafd63dc3fb0b8f90d63bcc0c414fd055bfb4e41999ec77bc5d4114e1e247bf513f94bd1d80b25ecd1b29029bd8bda5d4c95707eb0e94e5
+  metadata.gz: 123b0d0306cfc3096b34214c928a8c4af0dfff97e23717fe4cdf0bcac5c0e8d0b9897772e673042db1375a2db58e241f31128ff0e5a5eea41a8538ff2ed1b6cf
+  data.tar.gz: 8d6c93f8f60c9bf4be6ce75ad0a4c1a379d442c6d0ad5519d6b2c3738cef37be5869495b83459b0b004d34eba73602a2396d8b65cc9b10481cf8ab744710779d

data/.travis.yml

@@ -1,3 +1,4 @@
 language: ruby
+script: bundle exec rspec spec
 rvm:
   - 2.2.2

data/README.md

@@ -33,12 +33,32 @@ or:
 Prospector.configure do |config|
   config.secret_token = 'token from service'
   config.client_secret = 'secret from service'
+  config.background_adapter = :sidekiq
+
+  config.enabled = Rails.env.production?
 end
 ```
 
 ## Usage
 
-Currently the process of notifying the service is not automated.  In the future this will be provided via a rake task as well as a Rails integration.
+### Rails
+
+When the gem is included into a Rails project, you have the option of specifying a background adapter to run the notification service asynchronously on.  The default adapter is `ActiveJob` if available in your Rails project, but we also support `Sidekiq` at this time.
+
+You can choose to enable Prospector in the initializer file, or by the presence of an ENV variable "PROSPECTOR_ENABLED" as shown below.
+
+```ruby
+# set the ENV variable
+# ENV['PROSPECTOR_ENABLED'] = 'true'
+# or
+Prospector.configure do |config|
+  config.enabled = Rails.env.production?
+end
+```
+
+### Without Rails
+
+Without Rails, you need to manually call the method to notify the Prospector service yourself.
 
 ```ruby
 Prospector.notify!

data/lib/prospector.rb

@@ -5,6 +5,9 @@ require "prospector/version"
 require "prospector/client"
 require "prospector/configuration"
 require "prospector/error"
+require "prospector/background"
+
+require "prospector/railtie" if defined?(Rails)
 
 begin
   require "pry"
@@ -16,17 +19,29 @@ module Prospector
     attr_writer :configuration
   end
 
-  def self.configuration
-    @configuration ||= Configuration.new
-  end
+  module ClassMethods
+    def configuration
+      @configuration ||= Configuration.new
+    end
 
-  def self.configure
-    yield(configuration)
-  end
+    def configure
+      yield(configuration)
+    end
+
+    def enabled?
+      configuration.enabled?
+    end
 
-  def self.notify!
-    specifications = Bundler.environment.specs
+    def notify!
+      raise NotEnabledError unless enabled?
 
-    Client.deliver(specifications)
+      configuration.notify!
+
+      specifications = Bundler.environment.specs
+
+      Client.deliver(specifications)
+    end
   end
+
+  extend ClassMethods
 end

data/lib/prospector/background.rb

@@ -0,0 +1,13 @@
+require "prospector/background/coordinator"
+require "prospector/background/notify_job" if defined?(ActiveJob::Base)
+require "prospector/background/notify_worker" if defined?(Sidekiq::Worker)
+
+module Prospector
+  module Background
+    def enqueue
+      Coordinator.new.enqueue
+    end
+
+    module_function :enqueue
+  end
+end

data/lib/prospector/background/coordinator.rb

@@ -0,0 +1,37 @@
+module Prospector; module Background
+  class Coordinator
+    def enqueue
+      return unless Prospector.enabled?
+
+      case adapter_name
+      when :active_job then enqueue_via_active_job
+      when :sidekiq then enqueue_via_sidekiq
+      when :none then perform_immediately
+      else
+        raise UnsupportedAdapterError.new(adapter_name)
+      end
+    end
+
+    private
+
+    def adapter_name
+      @adapter_name ||= Prospector.configuration.background_adapter
+    end
+
+    def enqueue_via_active_job
+      raise UnsupportedAdapterError unless defined?(NotifyJob)
+
+      NotifyJob.perform_later
+    end
+
+    def enqueue_via_sidekiq
+      raise UnsupportedAdapterError unless defined?(NotifyWorker)
+
+      NotifyWorker.perform_async
+    end
+
+    def perform_immediately
+      Prospector.notify!
+    end
+  end
+end; end

data/lib/prospector/background/notify_job.rb

@@ -0,0 +1,7 @@
+module Prospector; module Background
+  class NotifyJob < ActiveJob::Base
+    def perform
+      Prospector.notify!
+    end
+  end
+end; end

data/lib/prospector/background/notify_worker.rb

@@ -0,0 +1,9 @@
+module Prospector; module Background
+  class NotifyWorker
+    include Sidekiq::Worker
+
+    def perform
+      Prospector.notify!
+    end
+  end
+end; end

data/lib/prospector/client.rb

@@ -9,6 +9,7 @@ module Prospector
 
       case response.code
       when "401" then raise AuthenticationError
+      when "402" then raise AccountSubscriptionStatusError, json[:error]
       when "200" then return true
       else
         raise UnknownError
@@ -29,6 +30,10 @@ module Prospector
       @endpoint ||= URI('http://api.gemprospector.com/v1/specifications.json')
     end
 
+    def json
+      @json ||= JSON.parse(response.body)
+    end
+
     def build_request
       request = Net::HTTP::Post.new(endpoint)
       request['X-Auth-Token']   = Prospector.configuration.secret_token

data/lib/prospector/configuration.rb

@@ -1,6 +1,34 @@
 module Prospector
   class Configuration
-    attr_writer :secret_token, :client_secret
+    attr_writer :client_secret,
+                :enabled,
+                :secret_token
+
+    def initialize
+      @notified = false
+    end
+
+    def enabled?
+      return @enabled unless @enabled.nil?
+
+      @enabled = ENV['PROSPECTOR_ENABLED'] == 'true'
+    end
+
+    def notify!
+      @notified = true
+    end
+
+    def notified?
+      @notified == true
+    end
+
+    def background_adapter
+      @background_adapter ||= background_adapter_from_env || determine_default_background_adapater
+    end
+
+    def background_adapter=(value)
+      @background_adapter = value.to_sym
+    end
 
     def secret_token
       @secret_token || ENV['PROSPECTOR_SECRET_TOKEN'] || raise(InvalidCredentialsError)
@@ -9,5 +37,20 @@ module Prospector
     def client_secret
       @client_secret || ENV['PROSPECTOR_CLIENT_SECRET'] || raise(InvalidCredentialsError)
     end
+
+    private
+
+    def background_adapter_from_env
+      return if ENV['PROSPECTOR_BACKGROUND_ADAPTER'].nil?
+
+      ENV['PROSPECTOR_BACKGROUND_ADAPTER'].to_sym
+    end
+
+    def determine_default_background_adapater
+      return :active_job if defined?(ActiveJob)
+      return :sidekiq if defined?(Sidekiq)
+
+      :none
+    end
   end
 end

data/lib/prospector/error.rb

@@ -2,5 +2,8 @@ module Prospector
   class Error < StandardError; end
   class AuthenticationError < Error; end
   class InvalidCredentialsError < Error; end
+  class AccountSubscriptionStatusError < Error; end
+  class NotEnabledError < Error; end
+  class UnsupportedAdapterError < Error; end
   class UnknownError < Error; end
 end

data/lib/prospector/railtie.rb

@@ -0,0 +1,9 @@
+module Prospector
+  class Railtie < Rails::Railtie
+    initializer 'prospector.railtie' do |app|
+      ActiveSupport.on_load :action_controller do |app|
+        Background.enqueue
+      end
+    end
+  end
+end

data/lib/prospector/version.rb

@@ -1,3 +1,3 @@
 module Prospector
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/prospector.gemspec

@@ -23,5 +23,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "bundler", "~> 1.10"
 
   spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "webmock", "~> 1.21"
   spec.add_development_dependency "vcr", "~> 2.9"
+  spec.add_development_dependency "rspec", "~> 3.3"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prospector
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Matthew Millsaps-Brewer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-06-18 00:00:00.000000000 Z
+date: 2015-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -52,6 +52,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.21'
 - !ruby/object:Gem::Dependency
   name: vcr
   requirement: !ruby/object:Gem::Requirement
@@ -66,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.3'
 description: Gem Prospector allows your team to stay on top of important updates to
   gems in your Ruby project.
 email:
@@ -85,9 +113,14 @@ files:
 - bin/console
 - bin/setup
 - lib/prospector.rb
+- lib/prospector/background.rb
+- lib/prospector/background/coordinator.rb
+- lib/prospector/background/notify_job.rb
+- lib/prospector/background/notify_worker.rb
 - lib/prospector/client.rb
 - lib/prospector/configuration.rb
 - lib/prospector/error.rb
+- lib/prospector/railtie.rb
 - lib/prospector/version.rb
 - prospector.gemspec
 homepage: http://www.gemprospector.com