prospector 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4ea6ae785fa211406e6a4ff2e033dec0c8c0deca
-  data.tar.gz: 89739a65b7bdea8a3324523397d4711185c070ed
+  metadata.gz: 3271fbbd98467dba799a853bfd28e229274a539d
+  data.tar.gz: 57cb3a89d4a5398524682622ba2c88e0b2675f02
 SHA512:
-  metadata.gz: 2fd0d5cd8bbbd4bb783881236301ee4e56081bed86dac1903b8e5e68927943f38e20a5fa3c13b93281c7cf4469b08f34a3dc642bc3791b80c5ceb561aa541357
-  data.tar.gz: f0afbf0e2512dc5ce8d42b29341e5181de16ff87690d48d0aa2de67aed974b4b19c3cc2f9e3bf849db4e72eb37028b23d43c57ac08995977ee1ac13e30c0a599
+  metadata.gz: 9572530d8f6b69114949fd0b09e72d74a3a24fc56595cf7a2cbdd1d819c974d4cba7f7b0962002dab592e7e09e5cc5b4a10497e7695287584c1fc2fab6d8e913
+  data.tar.gz: 5b3f831db4b95f8c63899e41b7bc641f5f748f1b8fdac72a1e7c86fa064b337bf834d9ba270ed9ec0bc5dd68a2cea95887f836349d70420e3d563430d29bda7f

data/README.md

@@ -20,14 +20,18 @@ Or install it yourself as:
 
 ## Configuration
 
-The access token and secret can be configured either via environment variables, or with an initializer block.
+Projects can be configured via environment variables, a code block, or a RubyMotion configuration.
+
+### Environment Variables
 
 ```sh
+export PROSPECTOR_ENABLED=true
 export PROSPECTOR_SECRET_TOKEN=token
 export PROSPECTOR_CLIENT_SECRET=secret
+export PROSPECTOR_BACKGROUND_ADAPTER=sidekiq
 ```
 
-or:
+### Code Block
 
 ```ruby
 Prospector.configure do |config|
@@ -39,26 +43,48 @@ Prospector.configure do |config|
 end
 ```
 
+### RubyMotion
+
+A common configuration for a RubyMotion project follows, enabling only for release builds.
+
+```ruby
+Motion::Project::App.setup do |app|
+  app.prospector do |config|
+    config.secret_token = 'token from service'
+    config.client_secret = 'secret from service'
+  end
+
+  app.release do
+    app.prospector do |config|
+      config.enabled = true
+    end
+  end
+end
+```
+
 ## Usage
 
 ### 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.
+Rails integration includes automatic detection and support for ActiveJob as well as Sidekiq, to deliver usage details to the Prospector API in the background on app boot.  Additionally, the rake task mentioned below is available to use at any time you see fit, for example as part of your deployment process.
 
-You can choose to enable Prospector in the initializer file, or by the presence of an ENV variable "PROSPECTOR_ENABLED" as shown below.
+Valid background adapter options are `active_job`, `sidekiq`, and `none`.  ActiveJob is preferred and chosen in Rais 4.2 and above with built-in ActiveJob support.
 
-```ruby
-# set the ENV variable
-# ENV['PROSPECTOR_ENABLED'] = 'true'
-# or
-Prospector.configure do |config|
-  config.enabled = Rails.env.production?
-end
+### RubyMotion
+
+Integration with RubyMotion is accomplished via a Rake task that can be run by hand, or simply letting the build system do it's magic.  By default, if you have enabled Prospector via an environment variable, or a configuration block, any time the binary is built for a device (such as for distribution) then Prospector will be notified without any further action.
+
+### Rake Task
+
+If you prefer to notify the Prospector service at any other time, you can use the included Rake task.
+
+```
+rake prospector:deliver
 ```
 
-### Without Rails
+### Manually
 
-Without Rails, you need to manually call the method to notify the Prospector service yourself.
+If you prefer to notify the Prospector API without using the included Rails or RubyMotion support, you can always call directly.
 
 ```ruby
 Prospector.notify!

data/lib/prospector.rb

@@ -6,8 +6,10 @@ require "prospector/client"
 require "prospector/configuration"
 require "prospector/error"
 require "prospector/background"
+require "prospector/tasks"
 
 require "prospector/railtie" if defined?(Rails)
+require "prospector/motion/config" if defined?(Motion::Project::Config)
 
 begin
   require "pry"

data/lib/prospector/motion/config.rb

@@ -0,0 +1,9 @@
+module Motion; module Project; class Config
+  variable :prospector
+
+  def prospector(&block)
+    Prospector.configure(&block) if block_given?
+
+    Prospector.configuration
+  end
+end; end; end

data/lib/prospector/railtie.rb

@@ -3,5 +3,9 @@ module Prospector
     config.after_initialize do
       Background.enqueue unless Object.const_defined?('Rake')
     end
+
+    rake_tasks do
+      require File.expand_path('../tasks', __FILE__)
+    end
   end
 end

data/lib/prospector/tasks.rb

@@ -0,0 +1,31 @@
+require 'rake'
+
+namespace :prospector do
+
+  # Will load and run initializers for configuration info if provided
+  task :require do
+    Rake::Task['environment'].invoke if defined?(Rails)
+
+    App.config if defined?(Motion::Project)
+  end
+
+  desc 'Deliver usage details to Prospector API service'
+  task deliver: ['prospector:require'] do
+    Prospector.notify!
+  end
+
+  task deliver_quietly: ['prospector:require'] do
+    if Prospector.enabled?
+      App.info 'Prospector', 'Begin uploading usage details to API'
+
+      Prospector.notify!
+
+      App.info 'Prospector', 'Upload complete'
+    end
+  end
+
+  # Hook into archive build hook for RubyMotion projects
+  if Rake::Task.task_defined?('build:device')
+    Rake::Task['build:device'].enhance(['prospector:deliver_quietly'])
+  end
+end

data/lib/prospector/version.rb

@@ -1,3 +1,3 @@
 module Prospector
-  VERSION = "0.2.2"
+  VERSION = "0.3.0"
 end

data/lib/tasks/prospector.rake

@@ -0,0 +1 @@
+load(File.expand_path(File.join(File.dirname(__FILE__), '../prospector/tasks.rb')))

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: prospector
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Matthew Millsaps-Brewer
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-08-20 00:00:00.000000000 Z
+date: 2015-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -120,8 +120,11 @@ files:
 - lib/prospector/client.rb
 - lib/prospector/configuration.rb
 - lib/prospector/error.rb
+- lib/prospector/motion/config.rb
 - lib/prospector/railtie.rb
+- lib/prospector/tasks.rb
 - lib/prospector/version.rb
+- lib/tasks/prospector.rake
 - prospector.gemspec
 homepage: http://www.gemprospector.com
 licenses:
@@ -143,9 +146,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.4.8
 signing_key: 
 specification_version: 4
 summary: Prospector provides a simple integration with the Gem Prospector service.
 test_files: []
-has_rdoc: