capistrano-rpush 0.1.5 → 0.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 90fc8fb1692c31efa341b32f0eb011604fa23bea
-  data.tar.gz: 4032938c101c77cc4f204fe5cb0952c6e170dd26
+  metadata.gz: 60141bba843f6aff20a51b405cbc45b99107c039
+  data.tar.gz: 488e40a18d74149117e3bfc915456e1715ee0c01
 SHA512:
-  metadata.gz: 6c62a68360605cd25dfe438397b2204ff269c85f2327fc8fb5240abfefce7050e793540b5b5a952490adcc50d828133babf71461596476a77889813dc9ca9d5a
-  data.tar.gz: 78c988fb1ff1d2e078484f8283569a9a051fbe8a872b2653d743934690cc754e4e668e638ab42ef674781a8a3550e364f5e32fa7fa90b667e949f38abeb79b37
+  metadata.gz: 9db7f414ed198c965d591feb8574713bd6deead9a84ca8b7d51eb02754ea2b88ffa6c9d8803f48d88e0d7f4c6a8ef7be85da81cc7117397859eec3123aa9706c
+  data.tar.gz: 50faebcc882f2be160a3020c0b7fccca439bc93768a7a4c6b22299956cfc9afc7de0c3b9a9c55ad088177d20acfc8cc0b79379c4f9c7a1fc691f2e640ad23200

data/README.md

@@ -1,8 +1,30 @@
+[![Gem Version](https://badge.fury.io/rb/capistrano-rpush.svg)](https://badge.fury.io/rb/capistrano-rpush)
+
 # Capistrano::Rpush
 
-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/capistrano/rpush`. To experiment with that code, run `bin/console` for an interactive prompt.
+[Capistrano::Rpush](https://github.com/juicyparts/capistrano-rpush) adds [Rpush](https://rubygems.org/gems/rpush) tasks to your Capistrano deployment.
+
+## Rpush
+
+This gem was developed against version 2.7.0. Additionally it only provides tasks over a subset of available commands:
 
-TODO: Delete this and the text above, and describe your gem
+    $ rpush --help
+```
+Commands:
+  rpush help [COMMAND]  # Describe available commands or one specific command
+  rpush init            # Initialize Rpush into the current directory
+  rpush push            # Deliver all pending notifications and then exit
+  rpush start           # Start Rpush
+  rpush status          # Show the internal status of the running Rpush instance.
+  rpush stop            # Stop Rpush
+  rpush version         # Print Rpush version
+
+Options:
+  -c, [--config=CONFIG]
+                               # Default: config/initializers/rpush.rb
+  -e, [--rails-env=RAILS-ENV]
+                               # Default: development
+```
 
 ## Installation
 
@@ -22,17 +44,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+```ruby
+  # In Rails.root/Capfile
+
+
+  require 'capistrano/rpush'
+```
+
+Now you can use cap -T to list tasks:
+
+```
+cap rpush:restart  # Restart rpush
+cap rpush:start    # Start rpush
+cap rpush:status   # Status rpush
+cap rpush:stop     # Stop rpush
+```
+
+### Configuration
+
+The following configurable options are available, and listed with their defaults. Override them to suit your project's needs:
+
+```ruby
+  set :rpush_role, :app
+  set :rpush_env,  -> { fetch(:rack_env, fetch(:rails_env, fetch(:stage))) }
+  set :rpush_conf, -> { File.join(shared_path, 'config', 'rpush.rb') }
+  set :rpush_log,  -> { File.join(shared_path, 'log', 'rpush.log') }
+  set :rpush_pid,  -> { File.join(shared_path, 'tmp', 'pids', 'rpush.pid') }
+```
 
-## Development
+The options assume ```rpush.rb``` is defined in ```linked_files```. They also assume the following directories are listed in ```linked_dirs```:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+    tmp/pids log
 
-To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/capistrano-rpush. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/juicyparts/capistrano-rpush. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 
 ## License

data/lib/capistrano/rpush/version.rb

@@ -1,5 +1,5 @@
 module Capistrano
   module Rpush
-    VERSION = "0.1.5"
+    VERSION = "0.1.6"
   end
 end

data/lib/capistrano/tasks/rpush.rake

@@ -22,7 +22,6 @@ namespace :rpush do
 
   task :check do
     on roles (fetch(:rpush_role)) do |role|
-      #Create rpush.rb for new deployments
       unless  test "[ -f #{fetch(:rpush_conf)} ]"
         warn 'rpush.rb NOT FOUND!'
         info 'Configure rpush for your project before attempting a deployment.'
@@ -103,11 +102,10 @@ namespace :rpush do
 
   def rpush_user(role)
     properties = role.properties
-    properties.fetch(:rpush_user) ||               # local property for rpush only
+    properties.fetch(:rpush_user) ||  # local property for rpush only
     fetch(:rpush_user) ||
-    properties.fetch(:run_as) || # global property across multiple capistrano gems
+    properties.fetch(:run_as) ||      # global property across multiple capistrano gems
     role.user
   end
 
 end
-

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: capistrano-rpush
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.1.6
 platform: ruby
 authors:
 - Mel Riffe
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2016-03-24 00:00:00.000000000 Z
+date: 2016-03-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -108,8 +108,6 @@ files:
 - LICENSE.txt
 - README.md
 - Rakefile
-- bin/console
-- bin/setup
 - capistrano-rpush.gemspec
 - lib/capistrano/rpush.rb
 - lib/capistrano/rpush/version.rb

data/bin/console

@@ -1,14 +0,0 @@
-#!/usr/bin/env ruby
-
-require "bundler/setup"
-require "capistrano/rpush"
-
-# You can add fixtures and/or initialization code here to make experimenting
-# with your gem easier. You can also use a different console, if you like.
-
-# (If you use this, don't forget to add pry to your Gemfile!)
-# require "pry"
-# Pry.start
-
-require "irb"
-IRB.start

data/bin/setup

@@ -1,8 +0,0 @@
-#!/usr/bin/env bash
-set -euo pipefail
-IFS=$'\n\t'
-set -vx
-
-bundle install
-
-# Do any other automated setup that you need to do here