rushover-cli 0.0.10

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 0bf71cf3daecc9702a49854db85fb3f06d00300b
+  data.tar.gz: e5bd32a3f063318b4125a37650539bfde29608f3
+SHA512:
+  metadata.gz: 913cacac65282493f853ee01dbef46aac065c8194d955206203ec5df23fd69a7769198c4c76b1bdbd99c7879bb50faa1c0e9f653990294eaa770fdaf9d9af949
+  data.tar.gz: 2534df47a5452c213a08e293e1f04a6690dc90036a70d0e2ce7cca7c212eead7dab83195bd48db85901967eb29799e0b53ee3287eabc9972074465e0ad4a06ad

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/pkg/
+/doc/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,3 @@
+language: ruby
+rvm:
+  - 2.1.2

data/CHANGELOG.md

@@ -0,0 +1,20 @@
+# Change Log
+
+## 0.0.10 --- 2014-10-08
+
+### Fixed
+
+- Fixed bug where running `rushover config` without any flags would delete keys
+
+## 0.0.9 --- 2014-10-08
+
+### Changed
+
+- Changed wording of usage from "rush" to "rushover"
+
+## 0.0.8 --- 2014-10-07
+
+### Changed
+
+- `push` command now used to send Pushover notifications
+- `config` command now used to set user keys and app tokens

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in rushover-cli.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 brandonpittman
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,44 @@
+# Rushover::Cli
+
+`rushover-cli` is a command line interface to the `rushover` gem.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rushover-cli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rushover-cli
+
+## Usage
+
+    rushover config -u USER_KEY -a APP_TOKEN
+    rushover push MESSAGE [-t title]
+
+## Caveats
+
+`rushover-cli` requires a `:user` key and a `:rush` key to be saved to `~/.rushrc`.
+
+    # Example
+
+    ---
+    :user: youruserkey
+    :rush: anyapptoken
+
+The application you use doesn't need to be named 'rush'. It just needs to be any app token. If you want to change the title that gets passed to Pushover, just use the `-t` option.
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/rushover-cli/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,7 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+

data/bin/rushover

@@ -0,0 +1,63 @@
+#!/usr/bin/env ruby
+
+require 'rushover/cli'
+
+rush = Rushover::Cli::Rush.new
+
+opts = Slop.parse! do
+  on :v, :version, 'Print version number' do
+    puts Rushover::Cli::VERSION
+  end
+  on :h, :help, 'Display help'
+
+  # This command is used to set user key and app token in the YAML::Store.
+  # @since 0.0.8 
+  command 'config' do
+    banner 'Usage: rushover config -u USER_KEY -a APP_TOKEN'
+    on :u=, :user=, 'Your user key'
+    on :a=, :app=, 'Your app token'
+    on :h, :help, 'Print help'
+
+    run do |opts|
+      if opts[:h] || (!opts[:u] && !opts[:a])
+        puts opts
+        exit
+      else
+        rush.add_key(:user, opts[:user])
+        rush.add_key(:rush, opts[:app])
+      end
+    end
+  end
+
+  # This command is used to send notifications using Pushover.
+  # @since 0.0.8 
+  command 'push' do
+    banner 'Usage: rushover push MESSAGE [-t TITLE]'
+    on 't=', 'title=',  'An optional title'
+    on :h, :help, 'Print help'
+
+    run do |opts, args|
+      message = args.join(" ")
+
+      if opts[:h] || message.empty?
+        puts opts
+        exit
+      elsif message.length > 0
+        user_key = rush.get_key(:user)
+        app_token = rush.get_key(:rush)
+        client = Rushover::Client.new(app_token)
+        user = Rushover::User.new(user_key, client)
+        user.notify(message, title: opts[:title])
+      else
+        raise "You didn't provide a message."
+      end
+    end
+  end
+end
+
+# This little bit just helps catch the times when `rushover` is run without any
+# arguments or with the --help options.
+# @since 0.0.8 
+if opts[:h] || ARGV.empty?
+  puts opts
+end

data/lib/rushover/cli.rb

@@ -0,0 +1,95 @@
+require 'rushover'
+require "rushover/cli/version"
+require 'slop'
+require 'pathname'
+require 'yaml/store'
+
+# @author Brandon Pittman
+# This module is namespaced as Rushover::Cli in order to show it's connected to
+# the rushover gem.
+module Rushover
+  # This is the CLI for rushover.
+  module Cli
+
+    # This class is accessing helper methods used in the bin file.
+    class Rush
+
+      # @!group Rushover objects
+      # @param app_token [String]
+      # @return [Rushover::Client] Client object to be used in #notify
+      # @see #notify
+      # @since 0.0.2
+      def client(app_token)
+        Rushover::Client.new(app_token)
+      end
+
+      # @param user_key [String]
+      # @param client [Rushover::Client]
+      # @return [Rushover::User] User object to be used in #notify
+      # @see #notify
+      # @since 0.0.2
+      def user(user_key, client)
+        Rushover::User.new(user_key, client)
+      end
+      # @!endgroup
+
+      # @param user [Rushover::User]
+      # @return [Hash] response from Pushover
+      # @since 0.0.2
+      # @see #user
+      # @see #client
+      def notify(user)
+        user.notify(message, title: opts[:title])
+      end
+
+      # @!group Configuration management
+      # @return [Pathname] location of .rushrc file
+      # @since 0.0.2
+      def rc_file
+        Pathname.new("#{ENV['HOME']}/.rushrc")
+      end
+
+      # @return [Psych::Store] YAML Store consisting of a :user and :rush keys
+      # @since 0.0.2
+      def config
+        YAML::Store.new(rc_file)
+      end
+      # @!endgroup
+
+      # @!group Key management
+      # @param key_symbol [Symbol] symbol to fetch
+      # @return [String] value of fetched key
+      # @since 0.0.2
+      def get_key(key_symbol)
+        store = config
+        store.transaction do
+          store.fetch(key_symbol)
+        end
+      end
+
+      # @param key_symbol [Symbol] symbol to add
+      # @param key_value [String] value to assign to key_symbol
+      # @return [Psych::Store] updated YAML Store
+      # @since 0.0.2
+      # @note Currently not used by rushover-cli
+      # @todo Add ability to set :user and :rush keys
+      def add_key(key_symbol, key_value)
+        store = config
+        store.transaction do
+          store[key_symbol] = key_value
+        end
+      end
+      # @!endgroup
+
+      # @!group Miscellaneous
+      # @return [String] version number of `rushover-cli` as a String
+      # @since 0.0.2
+      def version
+        Rushover::Cli::VERSION
+      end
+      # @!endgroup
+
+    end
+  end
+end
+

data/lib/rushover/cli/version.rb

@@ -0,0 +1,6 @@
+module Rushover
+  module Cli
+    # rushover-cli version number
+    VERSION = "0.0.10"
+  end
+end

data/rushover-cli.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'rushover/cli/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rushover-cli"
+  spec.version       = Rushover::Cli::VERSION
+  spec.authors       = ["brandonpittman"]
+  spec.email         = ["brandonpittman@gmail.com"]
+  spec.summary       = %q{A command-line interface for the rushover gem.}
+  spec.description   = %q{A command-line interface for the rushover gem.}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec"
+  spec.add_dependency "slop", "~> 3.6"
+  spec.add_dependency "rushover"
+end

data/spec/rushover/cli_spec.rb

@@ -0,0 +1,22 @@
+require 'spec_helper'
+
+describe Rushover::Cli do
+
+  let(:rc_file) {Pathname.new("#{ENV['HOME']}/.rushrc")}
+  let(:rush) {Rushover::Cli::Rush.new}
+
+  it 'has a version number' do
+    expect(Rushover::Cli::VERSION).not_to be nil
+  end
+
+  context ".rushrc file exists" do
+    it "can read a rc file" do
+      if rc_file.exist?
+        expect(rush.get_key(:user)).to be_truthy
+        expect(rush.get_key(:rush)).to be_truthy
+      end
+    end
+  end
+
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'rushover/cli'

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: rushover-cli
+version: !ruby/object:Gem::Version
+  version: 0.0.10
+platform: ruby
+authors:
+- brandonpittman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: slop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.6'
+- !ruby/object:Gem::Dependency
+  name: rushover
+  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'
+description: A command-line interface for the rushover gem.
+email:
+- brandonpittman@gmail.com
+executables:
+- rushover
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- CHANGELOG.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/rushover
+- lib/rushover/cli.rb
+- lib/rushover/cli/version.rb
+- rushover-cli.gemspec
+- spec/rushover/cli_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.2
+signing_key: 
+specification_version: 4
+summary: A command-line interface for the rushover gem.
+test_files:
+- spec/rushover/cli_spec.rb
+- spec/spec_helper.rb
+has_rdoc: