formkeep 0.0.4 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3546579edb5c82ebe4f71cfe320a1fa8d99cf849
-  data.tar.gz: 3c88d322497c57aa0e5b6c5393bb0af15a1dc53a
+  metadata.gz: 39010b85dae02b735ece32fba20d702fd3da5f76
+  data.tar.gz: 8780c7d4e51078f7ab0a079a3815c5b3feafbcbd
 SHA512:
-  metadata.gz: 9964cf22048441282f6c3bf192f2bba58aa5cc6aaf9164a99b1c45217466d46f23ba3004aee9d91577436b67f2e7f9b9a35b636a24bc5fe5f505b11cb4699dd7
-  data.tar.gz: 64946daf0ab1a3d931288233d2abab29ef06c67245436f6aeef29c0d74452aec19c62943bc2d4e1dcd9d1e80c04f8bcce3021a41099714301d2eca0c97c9b642
+  metadata.gz: e272a06f95e4b4d6c9b751ca0f3b78a8ca64f64d152e8194f3a424dd37eb3acee2b5d7f1ef5255d2cb4157e8d5d64719f782c3ac0ac24c70d4a36cb3f981fbaf
+  data.tar.gz: 894ca58ff3ab786fe8d4a1d723ef1cbc2cd1311b64a432602d7d7778af152f026791c9db2d370aaa645a145fcd95afcd875355906d8e941d49ee3faeb2067b66

data/CHANGELOG.md

@@ -3,6 +3,12 @@
 ## Unreleased
 
 - `formkeep add FORM_NAME`
+## 0.0.5 --- 2014-10-23
+
+### Changed
+
+- changed `formkeep check` to `formkeep unread`
+
 ## 0.0.3 --- 2014-10-23
 
 ### Added

data/README.md

@@ -24,7 +24,7 @@ Or install it yourself as:
 
 It should look something like this:
 
-~~~
+~~~rb
 form_name: api_endpoint_url_in_full
 ~~~
 
@@ -32,8 +32,8 @@ You can have as many form entries as you like. They don't necessarily need to be
 
 ## Usage
 
-~~~
-formkeep check FORM
+~~~rb
+formkeep unread FORM
 ~~~
 
 ## Contributing

data/bin/formkeep

@@ -4,16 +4,16 @@ require 'formkeep'
 require 'slop'
 
 opts = Slop.parse do
-  banner "Usage: formkeep check FORM"
+  banner "Usage: formkeep unread FORM"
   on :h, :help, "Display help"
   on :v, :version, "Display version" do
     puts Formkeep::VERSION
     exit
   end
 
-  command 'check' do
+  command 'unread' do
     banner <<-EOF
-    Usage: formkeep check FORM
+    Usage: formkeep unread FORM
 
     Please make sure you have a valid Formkeep API endpoint saved in ~/.formkeep.yaml
     EOF
@@ -28,4 +28,4 @@ opts = Slop.parse do
   end
 end
 
-puts opts unless ARGV[0] == 'check'
+puts opts unless ARGV[0] == 'unread'

data/lib/formkeep.rb

@@ -13,23 +13,27 @@ module Formkeep
 
     # @!attribute form
     #   @return [String] name of Form to be used
+    # @since 0.0.4
     attr_accessor :form
 
     # Creates a Formkeep::Form object to make calling of other methods simpler.
     # @param [String] form name from `~/.formkeep.yaml`
     # @return [Formkeep::Form] Form object
+    # @since 0.0.4
     def initialize(form)
       @form = form
     end
 
     # @!group Getters
     # @return [Pstore] YAML::Store object
+    # @since 0.0.4
     def config
       YAML::Store.new("#{Dir.home}/.formkeep.yaml")
     end
 
     # @param [String] key to look up
     # @return [String] value of key
+    # @since 0.0.4
     def get_key(key)
       store = config
       store.transaction do
@@ -40,6 +44,7 @@ module Formkeep
     # @param [String] key to add/modify
     # @param [String] value to add/modify
     # @return [String] value that was added/modified
+    # @since 0.0.4
     def set_key(key, value)
       store = config
       store.transaction do
@@ -49,16 +54,19 @@ module Formkeep
 
     # Sets API endpoint
     # @return [String] API endpoint URL
+    # @since 0.0.4
     def api
       get_key(form)
     end
 
     # @return [String] text of API call
+    # @since 0.0.4
     def response
       Net::HTTP.get_response(URI(api)).body
     end
 
     # @return [Array] all submissions
+    # @since 0.0.4
     def submissions
       all = JSON.parse(response)["submissions"]
       all.reject { |sub| sub["spam"] }
@@ -66,16 +74,19 @@ module Formkeep
 
     # Latest submission info
     # @return [Hash] first submission from submissions array
+    # @since 0.0.4
     def latest_submission
       submissions[0]
     end
 
     # @return [String] name of latest submission
+    # @since 0.0.4
     def latest_name
       latest_submission.fetch("name")
     end
 
     # @return [String] email of latest submission
+    # @since 0.0.4
     def latest_email
       latest_submission.fetch("email")
     end
@@ -83,6 +94,7 @@ module Formkeep
 
     # @!group Parsers
     # @return [Array] all unread submissions
+    # @since 0.0.4
     def unread_submissions
       submissions.reject do |submission|
         submission.fetch("read_at")
@@ -90,6 +102,7 @@ module Formkeep
     end
 
     # @return [Array] all read submissions
+    # @since 0.0.4
     def read_submissions
       submissions.select do |submission|
         submission.fetch("read_at")

data/lib/formkeep/version.rb

@@ -1,4 +1,4 @@
 module Formkeep
   # Sets version for RubyGems
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/spec/formkeep_spec.rb

@@ -4,6 +4,7 @@ describe Formkeep do
 
   let(:test) {Formkeep::Form.new("test")}
   let(:pixelsnatch) {Formkeep::Form.new("pixelsnatch")}
+  let(:subs) {pixelsnatch.submissions}
 
   it 'has a version number' do
     expect(Formkeep::VERSION).not_to be nil
@@ -14,10 +15,10 @@ describe Formkeep do
   end
 
   it "it pulls a submissions array" do
-    expect(pixelsnatch.submissions.class).to eq(Array)
+    expect(subs.class).to eq(Array)
   end
 
   it "pulls the latest submission" do
-    expect(pixelsnatch.latest_submission.class).to eq(Hash) if pixelsnatch.submissions.length > 0
+    expect(pixelsnatch.latest_submission.class).to eq(Hash) if subs.length > 0
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: formkeep
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
 platform: ruby
 authors:
 - brandonpittman