formkeep 0.0.6 → 0.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 098be4e864dd79d7ed84fb6a0b5f78cc2091ec22
-  data.tar.gz: 5a4dbe8aeacf0a7c1e9ec57bcf06a63053eee53b
+  metadata.gz: 191b02d3b0ae2b067e0906faecdfdfdad73ba205
+  data.tar.gz: 97795f03acdb1a2bab7b84a2f028859cca4c4dbf
 SHA512:
-  metadata.gz: f0c1fd27c0f2738c23aa92495fc57828445bd9b74a86e4ecb687f9ef8cfb24e545d1f3005b3bac20858b8146d24a25c8aa65c82cbbac6b1bb03cbc27cdaa2c78
-  data.tar.gz: 8ae5eae25ce2ee7f9271d0264b3780994de9dc813606671faf6ef7aa8e51f9f3b8ff0bf12b49ce3afb7a0d574ac81502a6abc2a1034decee244e17bf860bdef0
+  metadata.gz: 7cde1deac8d2e15cecf688b62ea134145db9a3280e9d4896ab781f70ac58f2f13f954717723118a8ee20659871c5820a8bedbd04249e9f0e280479052ed00332
+  data.tar.gz: 7cb10f36e1271a565a8f26760ac2008ff540c72d57617c3d118c0dc11e6941680e38174d3897c6c03afbde387e8c9d93ec626c415db76d3e4272563b7f63ed14

data/.hound.yml

@@ -0,0 +1,2 @@
+ruby:
+  enabled: true

data/CHANGELOG.md

@@ -2,7 +2,7 @@
 
 ## Unreleased
 
-- `formkeep add FORM_NAME`
+- `formkeep add FORM_NAME FORM_ENDPOINT`
 ## 0.0.6 --- 2014-10-24
 
 ### Added

data/Guardfile

@@ -0,0 +1,23 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'ctags-bundler', :src_path => ["app", "lib", "spec/support"] do
+  watch(/^(app|lib|spec\/support)\/.*\.rb$/)
+  watch('Gemfile.lock')
+end
+
+guard :rubocop, all_on_start: false do
+  watch(%r{^lib/.+\.rb$})
+  watch(%r{bin/.+})
+  watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
+end
+
+guard :rspec, cmd: 'bundle exec rspec' do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+  # Turnip features and steps
+  watch(%r{^spec/acceptance/(.+)\.feature$})
+  watch(%r{^spec/acceptance/steps/(.+)_steps\.rb$})   { |m| Dir[File.join("**/#{m[1]}.feature")][0] || 'spec/acceptance' }
+end

data/README.md

@@ -25,6 +25,7 @@ Or install it yourself as:
 It should look something like this:
 
 ~~~
+---
 form_name: api_endpoint_url_in_full
 ~~~
 
@@ -32,8 +33,12 @@ You can have as many form entries as you like. They don't necessarily need to be
 
 ## Usage
 
+Simply pass the key of the form from `~/.formkeep.yaml` to the `unread` command to check for unread messages. If you have [Sticky Notifications][sn] installed (OS X only) you can have a sticky notification created by passing the `-s` or `--sticky` flag.
+
+[sn]: http://instinctivecode.com/sticky-notifications/
+
 ~~~
-formkeep unread FORM
+formkeep unread FORM [-s]
 ~~~
 
 ## Contributing

data/Rakefile

@@ -1,6 +1,16 @@
 require "bundler/gem_tasks"
 require "rspec/core/rake_task"
 require 'yard'
+require 'rubocop/rake_task'
+
+desc 'Run RuboCop on the lib directory'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  # only show the files with failures
+  task.formatters = ['files']
+  # don't abort rake on failure
+  task.fail_on_error = false
+end
 
 RSpec::Core::RakeTask.new(:spec)
 

data/bin/formkeep

@@ -4,9 +4,9 @@ require 'formkeep'
 require 'slop'
 
 opts = Slop.parse do
-  banner "Usage: formkeep unread FORM"
-  on :h, :help, "Display help"
-  on :v, :version, "Display version" do
+  banner 'Usage: formkeep unread FORM'
+  on :h, :help, 'Display help'
+  on :v, :version, 'Display version' do
     puts Formkeep::VERSION
     exit
   end
@@ -15,17 +15,19 @@ opts = Slop.parse do
     banner <<-EOF
     Usage: formkeep unread FORM
 
-    Please make sure you have a valid Formkeep API endpoint saved in ~/.formkeep.yaml
+    Make sure you have a valid Formkeep API endpoint saved in ~/.formkeep.yaml
     EOF
-    on :s, :sticky, "Create sticky notification"
-    run do |opts, args|
-      unless args.empty?
+    on :s, :sticky, 'Create sticky notification'
+    run do |options, args|
+      if !args.empty?
         form = Formkeep::Form.new(args[0])
         count = form.unread_submissions.length
         puts count
-        form.sticky("#{form.form} has unread submissions.") if (opts[:s] && count > 0)
+        if options[:s] && count > 0
+          form.sticky("#{form.form} has unread submissions.")
+        end
       else
-        puts opts
+        puts options
       end
     end
   end

data/formkeep.gemspec

@@ -21,6 +21,11 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.7"
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec"
+  spec.add_development_dependency "guard"
+  spec.add_development_dependency "guard-rspec"
+  spec.add_development_dependency "guard-rubocop"
+  spec.add_development_dependency "guard-ctags-bundler"
+  spec.add_development_dependency "rubocop"
 
   spec.add_dependency "slop"
   spec.add_dependency "stickynotifications", "~> 0.0.5 "

data/lib/formkeep.rb

@@ -1,4 +1,4 @@
-require "formkeep/version"
+require 'formkeep/version'
 require 'pp'
 require 'json'
 require 'net/http'
@@ -8,10 +8,9 @@ require 'stickynotifications'
 # @author Brandon Pittman
 # Helper methods for accessing Formkeep API
 module Formkeep
-# @author Brandon Pittman
+  # @author Brandon Pittman
   # Helper methods for accessing Formkeep API
   class Form
-
     # @!attribute form
     #   @return [String] name of Form to be used
     # @since 0.0.4
@@ -69,8 +68,8 @@ module Formkeep
     # @return [Array] all submissions
     # @since 0.0.4
     def submissions
-      all = JSON.parse(response)["submissions"]
-      all.reject { |sub| sub["spam"] }
+      all = JSON.parse(response)['submissions']
+      all.reject { |sub| sub['spam'] }
     end
 
     # Latest submission info
@@ -83,13 +82,13 @@ module Formkeep
     # @return [String] name of latest submission
     # @since 0.0.4
     def latest_name
-      latest_submission.fetch("name")
+      latest_submission.fetch('name')
     end
 
     # @return [String] email of latest submission
     # @since 0.0.4
     def latest_email
-      latest_submission.fetch("email")
+      latest_submission.fetch('email')
     end
     # @!endgroup
 
@@ -98,7 +97,7 @@ module Formkeep
     # @since 0.0.4
     def unread_submissions
       submissions.reject do |submission|
-        submission.fetch("read_at")
+        submission.fetch('read_at')
       end
     end
 
@@ -106,14 +105,18 @@ module Formkeep
     # @since 0.0.4
     def read_submissions
       submissions.select do |submission|
-        submission.fetch("read_at")
+        submission.fetch('read_at')
       end
     end
     # @!endgroup
 
     # @!group Process
+    # @param text [String] text to pass to Sticky Notifications
+    # @return [Nil]
+    # @note This requires the OS X app, Sticky Notifications.
+    # @since 0.0.6
     def sticky(text)
-      StickyNotifications::Note.new.create(text)
+      StickyNotifications::Note.new.create(text, 'Formkeep')
     end
     # @!endgroup
   end

data/lib/formkeep/version.rb

@@ -1,4 +1,5 @@
+# @author "Brandon Pittman"
 module Formkeep
   # Sets version for RubyGems
-  VERSION = "0.0.6"
+  VERSION = '0.0.7'
 end

data/spec/formkeep_spec.rb

@@ -1,24 +1,27 @@
 require 'spec_helper'
 
 describe Formkeep do
+  let(:test) { Formkeep::Form.new('test') }
+  let(:pixelsnatch) { Formkeep::Form.new('pixelsnatch') }
+  let(:subs) { pixelsnatch.submissions }
 
-  let(:test) {Formkeep::Form.new("test")}
-  let(:pixelsnatch) {Formkeep::Form.new("pixelsnatch")}
-  let(:subs) {pixelsnatch.submissions}
-
-  it 'has a version number' do
+  it 'has a version number', cli: true do
     expect(Formkeep::VERSION).not_to be nil
   end
 
-  it 'pulls the correct API endpoint from the config YAML file' do
-    expect(test.api).to eq("test")
+  it 'pulls the correct API endpoint from the config YAML file', api: true do
+    expect(test.api).to eq('test')
   end
 
-  it "it pulls a submissions array" do
+  it 'it pulls a submissions array', api: true do
     expect(subs.class).to eq(Array)
   end
 
-  it "pulls the latest submission" do
+  it 'pulls the latest submission', api: true do
     expect(pixelsnatch.latest_submission.class).to eq(Hash) if subs.length > 0
   end
+
+  it 'creates a Sticky Notification', cli: true do
+    expect { test.sticky('Just testing Formkeep!') }.not_to raise_error
+  end
 end

data/spec/spec_helper.rb

@@ -1,2 +1,3 @@
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
 require 'formkeep'
+require 'guard/rspec'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: formkeep
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.7
 platform: ruby
 authors:
 - brandonpittman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-24 00:00:00.000000000 Z
+date: 2014-12-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -52,6 +52,76 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: guard
+  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: guard-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: guard-rubocop
+  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: guard-ctags-bundler
+  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: rubocop
+  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
@@ -89,9 +159,11 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".hound.yml"
 - ".travis.yml"
 - CHANGELOG.md
 - Gemfile
+- Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
@@ -121,7 +193,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.2
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 summary: A library for interacting with the formkeep API.