fluttrly 0.0.4 → 0.0.5

data/README.md

@@ -18,38 +18,62 @@ to be refactored.
 
 
 ##Usage
-** List an item **
+
+####List an item
+
     #fluttrly <command> <list>
     $ fluttrly list bouverdafs
     Task => "Nothing to see here, move along" at => 02-08-2011 18:57 PM 
 
-** Post an item **
+####Post an item
+
     #fluttrly <command> <list> <message>
     $ fluttrly post bouverdafs "gem'd"
-    $ fluttrly list bouverdafs
     Task => "gem'd" at => 02-10-2011 16:18 PM 
     Task => "Nothing to see here, move along" at => 02-08-2011 18:57 PM 
     
-** Update a task **
+####Update a task
+
     #fluttrly <command> <list>
     $ fluttrly update bouverdafs
     1: Task => "gem'd" at => 02-10-2011 16:18 PM (Completed? false)
     2: Task => "Nothing to see here, move along" at => 02-08-2011 18:57 PM (Completed? false)
     Which item would you like to edit?
     1
-    $ fluttrly list bouverdafs
     1: Task => "gem'd" at => 02-10-2011 16:18 PM (Completed? true)
     2: Task => "Nothing to see here, move along" at => 02-08-2011 18:57 PM (Completed? false)
     
-    
+####Delete a task
+    #fluttrly <command> <list>
+    $ fluttrly delete bouverdafs
+    1: Task => "Make a throwaway task for deleting" at => 05-10-2011 03:59 AM (Completed? false)
+    2: Task => "write tests for test::unit" at => 05-10-2011 03:56 AM (Completed? false)
+    3: Task => "Add to the README" at => 05-10-2011 03:56 AM (Completed? true)
+    4: Task => "Add delete functionality" at => 05-10-2011 03:56 AM (Completed? true)
+    Which item would you like to delete?
+    1
+    1: Task => "write tests for test::unit" at => 05-10-2011 03:56 AM (Completed? false)
+    2: Task => "Add to the README" at => 05-10-2011 03:56 AM (Completed? true)
+    3: Task => "Add delete functionality" at => 05-10-2011 03:56 AM (Completed? true)
+
+
+
+##Install
+    Fork or download this and play with it yourself! If you want to just test
+    it locally:
+    $ bundle
+    $ gem build fluttrly-gem.gemspec
+    $ gem install fluttrly-0.0.4.gem
+
+Or just grab the latest from rubygems.org and use it.
 
-    
-##Install 
     $ gem install fluttrly
 
+
+
 ##TO DO
-* Tom-doc this ish
 * Removing items completely (1 or many)
-* Adding to locked lists :\
+* Adding to locked lists 
+* Refactor for caching so we don't make so many http requests
 
 

data/Rakefile

@@ -1,2 +1,13 @@
 require 'bundler'
+require 'rubygems'
+require 'rake'
+
 Bundler::GemHelper.install_tasks
+
+task :default => :test
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+end

data/lib/fluttrly-gem.rb

@@ -1,126 +1,17 @@
-require 'rubygems'
+
+begin
+  require 'rubygems'
+rescue LoadError
+end
+
 require 'net/http'
 require 'JSON'
 require 'Time'
 
+$:.unshift File.join(File.dirname(__FILE__), *%w[.. lib])
 
-#require 'fluttrly-gem/command'
-module Fluttrly
-  # Your code goes here...
-  class Command
-    class << self
-      def execute(*args)
-        command = args.shift
-        list = args.shift
-        message = args.empty? ? nil : args.join(' ')
-
-        parse_arguments(command, list, message)
-
-      end
-
-      def parse_arguments(command, list, message)
-        return list(list) if command == 'list'
-        return post(list, message) if command == 'post'
-        return update(list) if command == 'update'
-      end
-
-      def update(list)
-        response = form_response(list)[1]
-        page = list(list)
-        if page
-          puts 'Which item would you like to edit?'
-          num = STDIN.gets.chomp.to_i
-          id = page[num-1]["task"]["id"]
-          update_task(id,response) 
-        end
-      end
-
-      def list(list)
-        response = form_response(list, true)[1]
-        if Net::HTTPSuccess === response
-          i = 1
-          page = JSON.parse(response.body)
-          page.each do |task|
-            puts("#{i}: Task => \"#{task["task"]["content"]}\" at => #{Time.parse(task["task"]["created_at"]).strftime("%m-%d-%Y %H:%M %p")} (Completed? #{task["task"]["completed"]})") 
-            i = i+1
-          end
-         if page.empty? 
-           puts "Oops, that list doesn't have any items yet!"
-           puts "Try: fluttrly post #{list} <message> first."
-           return false
-         end
-         page
-        else 
-          response.error! 
-        end
-      end
+require 'fluttrly-gem/command'
 
-      #Posting requires getting COOKIE om nom nom and a csrf token..
-      def post(list, message)
-        http, response = form_response(list)
-        if Net::HTTPSuccess === response
-          response = post_request(list, message, response,http)
-        else
-          response.error!
-        end
-      end
-
-      private
-
-      def form_response(list, get=nil)
-        
-        #refactors are welcome here =\
-        if get.nil?
-          uri = URI.parse("http://fluttrly.com/#{list}")
-        else
-          uri = URI.parse("http://fluttrly.com/#{list}.json")
-        end
-        
-        http = Net::HTTP.new(uri.host, uri.port)
-        response = http.request(Net::HTTP::Get.new(uri.request_uri))
-        [http, response]
-      end
-
-      def post_request(list, message, response, http)
-        #get the csrf-token, really wanna use hpricot here but...
-        auth_token = $1 if response.body =~ /"authenticity_token".*value="(.+)"/ or nil
-        raise "No authenticity token found :(" if auth_token.nil?
-
-        #COOKIE COOKIE COOKIE COOKIE COOKIE COOKIE
-        cookie = response['set-cookie'].split('; ')[0]
-
-        #ok ok, NOW send that post data
-        uri = URI.parse('http://fluttrly.com/tasks.js')
-        request = Net::HTTP::Post.new(uri.request_uri)
-        params = {
-                  'authenticity_token' => auth_token,
-                  'task[name]' => "#{list}",
-                  'task[content]' => "#{message}"
-        }
-        request["Cookie"] = cookie
-        request.set_form_data(params)
-        response = http.request(request)
-      end
-
-      def update_task(id, response)
-        auth_token = $1 if response.body =~ /"csrf-token".*content="(.+)"/ or nil
-        raise "No authenticity token found :(" if auth_token.nil?
-
-        #COOKIE COOKIE COOKIE COOKIE COOKIE COOKIE
-        cookie = response['set-cookie'].split('; ')[0]
-
-        uri = URI.parse("http://fluttrly.com/tasks/#{id}")
-        http = Net::HTTP.new(uri.host, uri.port) 
-        request = Net::HTTP::Put.new(uri.request_uri)
-        params = {
-                  'authenticity_token' => auth_token,
-                  'completed' => "true"
-        }
-        request["Cookie"] = cookie
-        request.set_form_data(params)
-        response = http.request(request)
-      end
+module Fluttrly
 
-    end
-  end
 end

data/lib/fluttrly-gem/command.rb

@@ -0,0 +1,253 @@
+
+# Command is used to execute the basic commands for interaction with
+# fluttrly.com
+#
+#
+module Fluttrly
+  class Command
+    class << self
+
+      # Takes arguments from command line
+      #
+      # args - The list of arguments passed in. If they are
+      #        in the wrong order, the proper command will not be
+      #        executed correctly when passed to parse_arguments()
+      #
+      def execute(*args)
+        command = args.shift
+        list = args.shift
+        message = args.empty? ? nil : args.join(' ')
+
+        parse_arguments(command, list, message)
+      end
+
+      # Receives arguments and delegates them appropriately
+      #
+      # command - First argument used to decide what additional method 
+      #           to call.
+      # list    - The list to use execute the command on.
+      # message - Used to post to a list.
+      #
+      # Returns output based on the method called.
+      def parse_arguments(command, list, message)
+        return list(list) if command == 'list' || command == 'l'
+        return post(list, message) if command == 'post' || command == 'p'
+        return update(list) if command == 'update' || command == 'c'
+        return delete(list) if command == 'delete' || command == 'd'
+        return help if command == 'help' || command == '-h'  
+      end
+
+      # Command used to delete one or all items in a list
+      #
+      # list - List to delete items from.
+      # num  - Number in the list to update if already known.
+      # 
+      # Returns a refreshed list showing the changes
+      def delete(list, num=nil)
+        response = form_response(list)[1]
+        page = list(list)
+        if page
+          puts "Which item would you like to delete?"
+          num = STDIN.gets.chomp.to_i if num.nil?
+          id = page[num-1]["task"]["id"]
+          delete_task(id, response)
+        #list(list)
+        end
+      end
+
+      # Command used if wanting to mark an item to edit
+      #
+      # list - List to update
+      # num  - Number in list to update if already known.
+      # 
+      # Returns the list with its items to show the change.
+      def update(list, num=nil)
+        response = form_response(list)[1]
+        page = list(list)
+        if page
+          puts 'Which item would you like to edit?'
+          num = STDIN.gets.chomp.to_i if num.nil?
+          id = page[num-1]["task"]["id"]
+          update_task(id,response) 
+          #list(list)
+        end
+      end
+
+      # Command used to list the items within a list
+      #
+      # list - List to show contents of.
+      #
+      # Returns a list of tasks for the given list.
+      def list(list)
+        response = form_response(list, true)[1]
+        if Net::HTTPSuccess === response
+          i = 1
+          page = JSON.parse(response.body)
+          puts ""
+          page.each do |task|
+            puts("#{i}: Task => \"#{task["task"]["content"]}\" at => #{Time.parse(task["task"]["created_at"]).strftime("%m-%d-%Y %H:%M %p")} (Completed? #{task["task"]["completed"]})") 
+            i = i+1
+          end
+          if page.empty? 
+            puts "Oops, that list doesn't have any items yet!"
+            puts "Try: fluttrly post #{list} <message> first."
+            return false
+          end
+          page
+        else 
+          response.error! 
+        end
+      end
+
+      # Used to post a message to a given list.
+      #
+      # list    - List to send a message to.
+      # message - Message to pass to the list.
+      #
+      # Returns a newly updated list.
+      def post(list, message)
+        http, response = form_response(list)
+        if Net::HTTPSuccess === response
+          response = post_request(list, message, response,http)
+        else
+          response.error!
+        end
+        #list(list)
+      end
+
+      # Command used to print out some helpful hints!
+      #
+      #
+      # Returns nothing.
+      def help
+        text = %{
+          Fluttrly is a nice web app to help you collaborate to-do lists
+          with your friends, this is the 'help' for its command line
+          interpreter.
+
+          Usage:
+            fluttrly -h/help
+            fluttrly <command> <list> <message for posting>
+
+          Examples:
+            fluttrly list bouverdafs             Output the list "Bouverdafs"
+            fluttrly post bouverdafs "winning"   Add to the list bouverdafs the message
+                                                 "winning"
+            fluttrly update bouverdafs           Presents the user with a prompt to
+                                                 allow them to update a specific item
+                                                 on that list.
+            fluttrly delete bouverdafs           Just like `update`,except allows user
+                                                 to delete a specific item from list. 
+
+          For more information please go to:
+          http://github.com/brntbeer/fluttrly-gem
+
+        }.gsub(/^ {8}/, '') #to strip 8 lines of whitespace
+        puts text
+      end
+
+      private
+
+      # Private: Gathers the appropriate response based upon what kind
+      #          of argument needs to be done.
+      #
+      # list - List to gather the response from.
+      # get  - Optional flag to pass for if we're simply getting a
+      #        refresh view of the list.
+      #
+      # Returns a Net::HTTP object for the given url, and a response.
+      def form_response(list, get=nil)
+
+        #refactors are welcome here =\
+        if get.nil?
+          uri = URI.parse("http://fluttrly.com/#{list}")
+        else
+          uri = URI.parse("http://fluttrly.com/#{list}.json")
+        end
+
+        http = Net::HTTP.new(uri.host, uri.port)
+        response = http.request(Net::HTTP::Get.new(uri.request_uri))
+        [http, response]
+      end
+
+
+      # Private: Used to set the actual post message.
+      #
+      # list     - List to perform the post on.
+      # message  - Message to post on the list.
+      # response - Response from a previous http request, used to 
+      #            get cookie and csrf token.
+      # http     - Net::HTTP object used to post the actual data.
+      #
+      # Returns nothing.
+      def post_request(list, message, response, http)
+        auth_token = $1 if response.body =~ /"authenticity_token".*value="(.+)"/ or nil
+        raise "Not authenticated to perform this action." if auth_token.nil?
+
+        #COOKIE COOKIE COOKIE COOKIE COOKIE COOKIE
+        cookie = response['set-cookie'].split('; ')[0]
+
+        uri = URI.parse('http://fluttrly.com/tasks.js')
+        request = Net::HTTP::Post.new(uri.request_uri)
+        params = {
+                  'authenticity_token' => auth_token,
+                  'task[name]' => "#{list}",
+                  'task[content]' => "#{message}"
+        }
+        request["Cookie"] = cookie
+        request.set_form_data(params)
+        response = http.request(request)
+      end
+
+      # Private: Performs the PUT method to update a given task.
+      #
+      # id       - The ID of the task we're updating.
+      # response - Response from a previous http request, used to
+      #            get cookie and csrf token.
+      #
+      # Returns nothing.
+      def update_task(id, response)
+        auth_token = $1 if response.body =~ /"csrf-token".*content="(.+)"/ or nil
+        raise "Not authenticated to perform this action." if auth_token.nil?
+
+        #COOKIE COOKIE COOKIE COOKIE COOKIE COOKIE
+        cookie = response['set-cookie'].split('; ')[0]
+
+        uri = URI.parse("http://fluttrly.com/tasks/#{id}")
+        http = Net::HTTP.new(uri.host, uri.port) 
+        request = Net::HTTP::Put.new(uri.request_uri)
+        params = {
+                  'authenticity_token' => auth_token,
+                  'completed' => "true"
+        }
+        request["Cookie"] = cookie
+        request.set_form_data(params)
+        response = http.request(request)
+      end
+
+      # Private: Performs the DELETE method to delete task(s)
+      #
+      # id       - The ID or ids of the task(s) we're updating
+      # response - The response from a previous http request, used to
+      #            get cookie and csrf token.
+      #
+      # Returns nothing.
+      def delete_task(id, response)
+        auth_token = $1 if response.body =~ /"csrf-token".*content="(.+)"/ or nil
+        raise "Not authenticated to perform this action." if auth_token.nil?
+
+        cookie = response['set-cookie'].split('; ')[0]
+
+        uri = URI.parse("http://fluttrly.com/tasks/#{id}")
+        http = Net::HTTP.new(uri.host, uri.port)
+        request = Net::HTTP::Delete.new(uri.request_uri)
+        params = {
+                  'authenticity_token' => auth_token,
+        }
+        request["Cookie"] = cookie
+        request.set_form_data(params)
+        response = http.request(request)
+      end
+    end
+  end
+end

data/lib/fluttrly-gem/version.rb

@@ -1,3 +1,3 @@
 module Fluttrly
-  VERSION = "0.0.4"
+  VERSION = "0.0.5"
 end

data/test/test_command.rb

@@ -0,0 +1,34 @@
+require 'test/unit'
+require 'rubygems'
+require 'fluttrly-gem'
+require 'net/http'
+require 'JSON'
+
+class TestCommand < Test::Unit::TestCase
+  
+  def setup
+    @list = Fluttrly::Command.list("bouverdafs")
+    @finished = @list.select{|item| item["task"]["completed"] == true }
+  end
+
+  def test_list_size_increases_after_post
+    Fluttrly::Command.post("bouverdafs", "8=======D~~~~")
+    new_size = Fluttrly::Command.list("bouverdafs").size
+    assert (new_size > @list.size)
+  end
+
+  def test_list_update_includes_newly_completed_item
+    Fluttrly::Command.update("bouverdafs", 1)
+    list = Fluttrly::Command.list("bouverdafs")
+    finished = list.select{|item| item["task"]["completed"] == true}
+    assert list.include?(finished.first)
+  end
+
+  def test_size_decreases_after_delete
+    #offset the item to be deleted due to code looking at num-1
+    Fluttrly::Command.delete("bouverdafs", (@list.size-@finished.size)+1)
+    new_size = Fluttrly::Command.list("bouverdafs").size
+    assert (new_size < @list.size)
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: fluttrly
 version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: false
+  hash: 21
+  prerelease: 
   segments: 
   - 0
   - 0
-  - 4
-  version: 0.0.4
+  - 5
+  version: 0.0.5
 platform: ruby
 authors: 
 - Brent Beer
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-02-12 00:00:00 -06:00
+date: 2011-05-17 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -52,7 +52,9 @@ files:
 - bin/fluttrly
 - fluttrly-gem.gemspec
 - lib/fluttrly-gem.rb
+- lib/fluttrly-gem/command.rb
 - lib/fluttrly-gem/version.rb
+- test/test_command.rb
 has_rdoc: true
 homepage: http://rubygems.org/gems/fluttrly
 licenses: []
@@ -83,9 +85,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: fluttrly-gem
-rubygems_version: 1.3.7
+rubygems_version: 1.6.0
 signing_key: 
 specification_version: 3
 summary: Fluttrly.com command line interface.
-test_files: []
-
+test_files: 
+- test/test_command.rb