pushover 1.0.4 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 315c0ceeee45f022f8d00fc608399bf53a71b131
-  data.tar.gz: 377d69dd15226e298deaaf4d179360710b54d5ec
+  metadata.gz: 070ec388b3b147c9cdaa660e44655ed570018779
+  data.tar.gz: '09023c3ab9cbcdf4e87c4363c75c5ab53f30cf74'
 SHA512:
-  metadata.gz: f0bdb2755a96aca9c8c22e43e187718930a76fff3f3b5d72bfd062c35cbaf85211cac7897f7a1da163f11950c9149627c7f61d9fa9392552aa66222833991bc6
-  data.tar.gz: d36021c61c655ba7897c78aa2d1cf717d4854d7b9b51f580e7445b768893bb6e06b12773ca599a3825dc194d12b0cd2c727513d0fdadc05b7441eba37bd347a9
+  metadata.gz: 4f01c3d41f2dd85311e338a205a9fd0909cb5caf3ef0586dc0f81ffef1e843f72dcfa36fa9f38cc63c9835f3a74891e1ffdbeeeaebf21e3a6a7f26c182d81ff2
+  data.tar.gz: ba00579dc02b4a7debe9ad1c4910805dffdf726a6821ca1d18b4ac8e09d02fc6dcca2309ddbc99e46d2bc37e0b16a9d6785901511e2145cbdd464f55c1bd0514

data/.rubocop.yml

@@ -0,0 +1,78 @@
+require: rubocop-rspec
+
+AllCops:
+  TargetRubyVersion: 2.4.0
+  Exclude:
+    - 'vendor/**/*'
+    - 'tmp/**/*'
+    - 'spec/spec_helper.rb'
+
+# The defaults for these seem to be based on a rails env, this is not rails.
+Metrics/ModuleLength:
+  CountComments: false
+  Max: 250
+
+Metrics/ClassLength:
+  Max: 250
+
+Metrics/MethodLength:
+  Max: 20
+
+Metrics/AbcSize:
+  Max: 25
+
+Metrics/CyclomaticComplexity:
+  Max: 8
+
+Metrics/PerceivedComplexity:
+  Max: 10
+
+# it's 2016, people have wide monitors.
+Metrics/LineLength:
+  Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - 'Guardfile'
+    - '*.gemspec'
+    - 'spec/**/*'
+
+# we exclude these two files since they are generated, the rest of our projects
+# should use // style regexps.
+Style/RegexpLiteral:
+  EnforcedStyle: slashes
+  AllowInnerSlashes: true
+  Exclude:
+    - 'Guardfile'
+    - '*.gemspec'
+
+# Prefer single-quoted strings when you don't need string interpolation or special symbols
+Style/StringLiterals:
+  Enabled: false
+
+Style/WordArray:
+  EnforcedStyle: brackets
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Style/MixinUsage:
+  Exclude:
+  - 'bin/*'
+
+# Specs don't need inline documentation.
+Style/Documentation:
+  Enabled: true
+  Exclude:
+    - 'spec/**/*'
+
+RSpec/NamedSubject:
+  Enabled: false
+
+Lint/Debugger:
+  Enabled: false
+
+# Purty hashes.
+Layout/AlignHash:
+  EnforcedHashRocketStyle: table
+  EnforcedColonStyle: table

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,46 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at ebrodeur@ujami.net. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -1,40 +1,3 @@
 source 'https://rubygems.org'
 
 gemspec
-
-platforms :rbx do
-  gem 'racc'
-  gem 'rubysl', '~> 2.0'
-  gem 'psych'
-end
-
-group :development do
-  gem "pry",           :require => false
-  gem "guard",         :require => false
-  gem "guard-bundler", :require => false
-  gem "guard-rspec",   :require => false
-  gem "guard-yard",    :require => false
-  gem "guard-shell",   :require => false
-  gem 'libnotify',     :require => false
-  gem 'growl',         :require => false
-  gem 'rb-inotify',    :require => false
-  gem 'rb-fsevent',    :require => false
-  gem 'rb-fchange',    :require => false
-end
-
-group :test do
-  gem "rspec", "~> 2.13.0"
-  gem "rspec-core", "~> 2.13.0"
-  gem "rspec-expectations", "~> 2.13.0"
-  gem "rspec-mocks", "~> 2.13.0"
-  gem "rake", "~> 10.1.0"
-  gem "webmock", "~> 1.13.0"
-end
-
-group :extended_testing do
-  gem "childprocess", "~> 0.3.9"
-  gem 'simplecov', "~> 0.7.1", :require => false
-  gem 'simplecov-rcov', "~> 0.2.3", :require => false
-end
-
-

data/Guardfile

@@ -1,33 +1,43 @@
-#!/usr/bin/ruby
-# Must be an array
-test_cmd = [
-  "bundle exec pushover a message"
-]
+clearing :on
 
 guard :bundler do
-	watch 'Gemfile'
-	watch '*.gemspec'
+  require 'guard/bundler'
+  require 'guard/bundler/verify'
+  helper = Guard::Bundler::Verify.new
+
+  files = ['Gemfile']
+  files += Dir['*.gemspec'] if files.any? { |f| helper.uses_gemspec?(f) }
+
+  # Assume files are symlinked from somewhere
+  files.each { |file| watch(helper.real_path(file)) }
 end
 
-guard :rspec do
-  watch(%r{^spec/.+_spec\.rb$})
-  watch(%r{^lib/(.+)\.rb$}) { |m| "spec/lib/#{m[1]}_spec.rb" }
-  watch(%r{^bin/(.+)\.rb$})         { |m| "spec/bin/#{m[1]}_spec.rb" }
-  watch('spec/spec_helper.rb')      { "spec" }
+guard :rspec, cmd: 'bundle exec rspec' do
+  require 'guard/rspec/dsl'
+  dsl = Guard::RSpec::Dsl.new(self)
+
+  # RSpec files
+  rspec = dsl.rspec
+  watch(rspec.spec_helper) { rspec.spec_dir }
+  watch(rspec.spec_support) { rspec.spec_dir }
+  watch(rspec.spec_files)
+
+  # Ruby files
+  ruby = dsl.ruby
+  dsl.watch_spec_files_for(ruby.lib_files)
 end
 
-# guard :yard do
-#   watch(%r{^lib/(.+)\.rb$})
-# end
-
-# guard :shell do
-#   watch /.*/ do |m|
-#     puts "Time: #{Time.now}, file saved: #{m}"
-#     test_cmd.each do |cmd|
-
-#       puts "=" * 80
-#       puts "cmd: #{cmd}"
-#       puts `#{cmd}`
-#     end
-#   end
-# end
+unless ENV["DISABLE_RUBOCOP"] == 'true'
+  guard :rubocop do
+    watch(/.+\.rb$/)
+    watch(%r{(?:.+/)?\.rubocop(?:_todo)?\.yml$}) { |m| File.dirname(m[0]) }
+  end
+end
+
+unless ENV["DISABLE_YARD"] == 'true'
+  guard 'yard' do
+    watch(%r{app\/.+\.rb})
+    watch(%r{lib\/.+\.rb})
+    watch(%r{ext\/.+\.c})
+  end
+end

data/LICENSE

@@ -1,36 +1,21 @@
-All software in this package is covered by the MIT license and beerware (rev42).
+MIT License
 
-   Copyright (c) 2011 Ernie Brodeur 
+Copyright (c) 2018 Ernie Brodeur
 
-   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:
+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 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.
-
-/*
- * ----------------------------------------------------------------------------
- * "THE BEER-WARE LICENSE" (Revision 42):
- * Ernie Brodeur wrote this package. As long as you retain this notice you
- * can do whatever you want with this stuff. If we meet some day, and you think
- * this stuff is worth it, you can buy me a beer in return.
- * ----------------------------------------------------------------------------
- */
-
-All contributed code is licensed accordingly and accredited whenever possible.
-If I make any mistake about this, please feel free to contact me at ebrodeur@ujami.net.
+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

@@ -1,7 +1,4 @@
 # Pushover
-**Master** [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/erniebrodeur/pushover) [![Build Status](https://travis-ci.org/erniebrodeur/pushover.png?branch=master)](https://travis-ci.org/erniebrodeur/pushover) [![Dependency Status](https://gemnasium.com/erniebrodeur/pushover.png)](https://gemnasium.com/erniebrodeur/pushover)
-
-**Development** [![Build Status](https://travis-ci.org/erniebrodeur/pushover.png?branch=development)](https://travis-ci.org/erniebrodeur/pushover)
 
 This gem provides a CLI and an API interface to http://pushover.net.
 
@@ -9,180 +6,56 @@ This gem provides a CLI and an API interface to http://pushover.net.
 
 To install:
 
-		% gem install pushover
+  % gem install pushover
 
 To use inside of an application, add this to the your gemfile:
 
-		% gem 'pushover'
+  % gem 'pushover'
 
 and run bundle to make it available:
 
-		% bundle
+  % bundle
 
 ## Usage
 
-### API:
+## API
+
 ```ruby
 require 'pushover'
 ```
 
-To send with the very minimum amount of information.
+### Create a message
 
 ```ruby
-Pushover.notification(message: 'message', title: 'title', user: 'USER_TOKEN', token: 'APP_TOKEN')
+message = Pushover.create {
+  user: '...',
+  token: '...',
+  message: '...'
+}
 ```
 
-Optional #configuration method:
-```ruby
-Pushover.configure do |config|
-  config.user='USER_TOKEN'
-  config.token='APP_TOKEN'
-end
+### Send the message
 
-Pushover.notification(message: 'message', title: 'title')
+```ruby
+  response = message.send
 ```
 
-### CLI:
-
-To get help do, try ```--(h)elp```
-
-		% pushover -h
-
-To send a message.
-
-		% pushover -u user_token -a app_key message is the rest of the cli.
-
-#### Optional parameters
-
-Most optional parameters have a shorter form you can use.  If that's the case, they will be displayed like ```--(h)elp```.
-
-#### Config_file
-
-The file to use for stored settings (including credentials).
-
-		% pushover --(c)onfig_file /tmp/config_file
-
-
-#### Title
-
-The title of the message, if not supplied it will end up being the app name.
-
-		% pushover --(t)itle "A title"
-
-		% pushover --(t)itle "A title"
-
-#### Priority
-
-Priority of the message, either (low,normal,high) or (-1,0,1).  For the string you only need the first letter.
-
-		% pushover --(p)riority high
-
-		% pushover --(p)riority h
-
-		% pushover --(p)riority -1
-
-#### Emergency Notifications
-
-Currently retry/expire is supported, currently these are in seconds.  Callback url's are not.
-
-		% pushover --emergency_retry 60
-
-		% pushover --emergency_expire 3600
-
-It won't pre-check values sent to the api, so you will need to tune for the current min/max values or check api documentation.
-
-#### Device
-
-Specific device to send the message too, must be registered at pushover.net
-
-		% pushover --(d)evice "Device name"
-
-#### URL
-
-Supplementary URL that can be passed with the message.
+### Response
 
-		% pushover --url "http://www.github.com/erniebrodeur/pushover"
+- The response will always include `status` and `request`.
+- When set, it will also include `errors` and `receipt`.
 
-##### URL Title
-
-The display string of the supplementary URL.
-
-		% pushover --url "http://www.git.com/erniebrodeur/pushover" --url_title "This repo."
-
-#### Time
-
-Time is tricky, I just pass the string off to the stdlib ```Time.parse```.  Therefore, if it fails I can't do much about it.  Though, it shouldn't fail, it seems to take just a ton of stuff.  You can always handle this yourself and just pass in an epoch (string or fixnum).
-
-		% pushover --time 1331249662
-
-		% pushover --time "6:30"
-
-##### String examples
-
-As far as I can tell, you can toss a ton of different things and get an output.
-
-* rfc822: Tue, 14 Nov 2000 14:55:07 -0500
-* xml: 1979-08-13T06:30:00.313UTC
-* Aug 13, 1979 6:30
-* 1979/08/13, 6:30:50 UTC
-* 6:30
-* 14:30
-* Aug 21
-
-##### Sounds
-
-Get the available list of sounds:
-
-		% pushover --sound_list
-
-Play a specific sound with a message:
-
-		% pushover --sound Magic
-		% pushover --sound per
-
-* You only need to supply an unambiguous partial string.
-* It is not case sensitive.
-
-#### Saving
-
-You can also save and use stored information.  The username/application are titles.  They can be anything you want to reference them.
-
-##### User
-
-		% pushover -u user_token --save-user email@somewhere.net
-
-##### Application
-
-		% pushover -a app_key --save-app myApp
-
-Delete done in the api, not lifted to the cli.
-
-Now, you can use these to send messages instead of having to remember the key:
-
-		% pushover -a myApp -u email@somewhere.net Hello from somewhere!
-
-If you don't supply the application or user name, it will use the first one in the save file.
-
-		% pushover so now I can just send an app.
-
-Anytime you supply tokens directly to the cli, it will ignore any saved information and try them.  This allows you to use it as a once-off tool while keeping credentials stored.
-
-## TODO
-
-### 1.0 tree
-
-* Callback urls.
-* Receipt testing.
-
-### 2.0 tree
+```ruby
+  response.status
+  response.request
+```
 
-* Rebuild the CLI so it works more like a git/bundle command.
-* More argument/string magic.
 
 ## Contributing
 
 1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Added some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+2. Switch to development (`git checkout developtment`)
+3. Create your feature branch (`git checkout -b my-new-feature`)
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request against `development`