formkeep 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 970cf5c12d629ca062de7191353668dbced8585b
-  data.tar.gz: 1451375588a2fc90a9947cabf606aa62cedfe905
+  metadata.gz: 3546579edb5c82ebe4f71cfe320a1fa8d99cf849
+  data.tar.gz: 3c88d322497c57aa0e5b6c5393bb0af15a1dc53a
 SHA512:
-  metadata.gz: 56c201ce701b662d563488c5a38d80ce159f40f0d615013e8779b061c5459af08bdb1be2e90cc439a09051895ef1b7fbdfbb677437be0e81d45bace1dd97edd4
-  data.tar.gz: 2a2429fcc0aa475aec77002d286ad9eb60909b006eb120dbed6749004cdd81a238e7aa8b930cace93785e7251eabe1f789a7365e3a1f24463443242915131808
+  metadata.gz: 9964cf22048441282f6c3bf192f2bba58aa5cc6aaf9164a99b1c45217466d46f23ba3004aee9d91577436b67f2e7f9b9a35b636a24bc5fe5f505b11cb4699dd7
+  data.tar.gz: 64946daf0ab1a3d931288233d2abab29ef06c67245436f6aeef29c0d74452aec19c62943bc2d4e1dcd9d1e80c04f8bcce3021a41099714301d2eca0c97c9b642

data/README.md

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

data/bin/formkeep

@@ -5,17 +5,24 @@ require 'slop'
 
 opts = Slop.parse do
   banner "Usage: formkeep check FORM"
-  on :v, :version do
+  on :h, :help, "Display help"
+  on :v, :version, "Display version" do
     puts Formkeep::VERSION
+    exit
   end
 
   command 'check' do
-    run do |options, args|
-      form = Formkeep::Cli.new(args[0]) if args
-      if form.unread_submissions.length > 0
-        puts "You have unread submissions!" 
+    banner <<-EOF
+    Usage: formkeep check FORM
+
+    Please make sure you have a valid Formkeep API endpoint saved in ~/.formkeep.yaml
+    EOF
+    run do |opts, args|
+      unless args.empty?
+        form = Formkeep::Form.new(args[0])
+        puts form.unread_submissions.length
       else
-        puts "You have no unread submissions."
+        puts opts
       end
     end
   end

data/lib/formkeep.rb

@@ -5,20 +5,31 @@ require 'net/http'
 require 'yaml/store'
 
 # @author Brandon Pittman
+# Helper methods for accessing Formkeep API
 module Formkeep
-  class Cli
+# @author Brandon Pittman
+  # Helper methods for accessing Formkeep API
+  class Form
 
+    # @!attribute form
+    #   @return [String] name of Form to be used
     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
     def initialize(form)
       @form = form
     end
 
     # @!group Getters
+    # @return [Pstore] YAML::Store object
     def config
       YAML::Store.new("#{Dir.home}/.formkeep.yaml")
     end
 
+    # @param [String] key to look up
+    # @return [String] value of key
     def get_key(key)
       store = config
       store.transaction do
@@ -26,6 +37,9 @@ module Formkeep
       end
     end
 
+    # @param [String] key to add/modify
+    # @param [String] value to add/modify
+    # @return [String] value that was added/modified
     def set_key(key, value)
       store = config
       store.transaction do
@@ -34,39 +48,48 @@ module Formkeep
     end
 
     # Sets API endpoint
+    # @return [String] API endpoint URL
     def api
       get_key(form)
     end
 
+    # @return [String] text of API call
     def response
       Net::HTTP.get_response(URI(api)).body
     end
 
+    # @return [Array] all submissions
     def submissions
-      JSON.parse(response)["submissions"]
+      all = JSON.parse(response)["submissions"]
+      all.reject { |sub| sub["spam"] }
     end
 
     # Latest submission info
+    # @return [Hash] first submission from submissions array
     def latest_submission
       submissions[0]
     end
 
+    # @return [String] name of latest submission
     def latest_name
       latest_submission.fetch("name")
     end
 
+    # @return [String] email of latest submission
     def latest_email
       latest_submission.fetch("email")
     end
     # @!endgroup
 
     # @!group Parsers
+    # @return [Array] all unread submissions
     def unread_submissions
       submissions.reject do |submission|
         submission.fetch("read_at")
       end
     end
 
+    # @return [Array] all read submissions
     def read_submissions
       submissions.select do |submission|
         submission.fetch("read_at")
@@ -75,7 +98,3 @@ module Formkeep
     # @!endgroup
   end
 end
-
-form = Formkeep::Cli.new("pixelsnatch")
-form.latest_submission.class # => Hash
-form.submissions.class # => Array

data/lib/formkeep/version.rb

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

data/spec/formkeep_spec.rb

@@ -2,8 +2,8 @@ require 'spec_helper'
 
 describe Formkeep do
 
-  let(:test) {Formkeep::Cli.new("test")}
-  let(:pixelsnatch) {Formkeep::Cli.new("pixelsnatch")}
+  let(:test) {Formkeep::Form.new("test")}
+  let(:pixelsnatch) {Formkeep::Form.new("pixelsnatch")}
 
   it 'has a version number' do
     expect(Formkeep::VERSION).not_to be nil

metadata

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