rsimpy 0.1.2

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,7 @@
+tmp*
+log*
+*[~#]
+optparse_example.rb
+pkg/*
+coverage*
+nbproject*

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Jamal Hansen
+
+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 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.rdoc

@@ -0,0 +1,21 @@
+= rsimpy
+
+A wrapper around the simpy rest api.
+
+== Copyright
+
+Copyright (c) 2009 Jamal Hansen. See LICENSE for details.
+
+== Todo
+
+Watchlists are currently not supported
+
+== Examples
+
+See examples folder
+
+== Configuration
+
+To store your Simpy username and config in ~/.rsimpy (not encrypted), you can run the Rake task:
+
+rake user:config username=USERNAME password=PASSWORD

data/Rakefile

@@ -0,0 +1,96 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rsimpy"
+    gem.summary = %Q{API Wrapper for simpy.com}
+    gem.email = "jamal.hansen@gmail.com"
+    gem.homepage = "http://github.com/rubyyot/rsimpy"
+    gem.authors = ["Jamal Hansen"]
+    gem.add_dependency('httparty', '>= 0.4.2')
+    gem.add_dependency('khayyam', '>= 0.0.1')
+    gem.add_development_dependency('cucumber', '>= 0.3.11')
+    gem.add_development_dependency('fakeweb', '>= 1.2.3')
+    gem.add_development_dependency('shoulda')
+    gem.add_development_dependency 'technicalpickles-jeweler'
+    gem.rubyforge_project = "rsimpy"
+
+
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install technicalpickles-jeweler -s http://gems.github.com"
+end
+
+require 'rubygems'
+begin
+  require 'cucumber'
+  require 'cucumber/rake/task'
+
+  Cucumber::Rake::Task.new(:features) do |t|
+    t.cucumber_opts = "--require features/support/env.rb --require features/links/steps --require features/tags/steps --require features/notes/steps --format pretty"
+  end
+
+rescue LoadError
+  desc 'Cucumber rake task not available'
+  task :features do
+    abort 'Cucumber rake task is not available. Be sure to install cucumber as a gem or plugin'
+  end
+end
+
+
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/*_test.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/*_test.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  if File.exist?('VERSION.yml')
+    config = YAML.load(File.read('VERSION.yml'))
+    version = "#{config[:major]}.#{config[:minor]}.#{config[:patch]}"
+  else
+    version = ""
+  end
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rsimpy #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+namespace :user do
+
+  desc 'store simpy login in cleartext in your home directory for safekeeping.  Use rake user:config login=USERNAME pass=PASSWORD'
+  task :config do
+    require 'lib/rsimpy'
+    
+    user = RSimpy::User.new ENV['login'], ENV['pass']
+    config = RSimpy::Configuration.new RSimpy::ProfileStorageService.new
+    config.user = user
+    config.save
+  end
+
+end
+

data/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:major: 0
+:minor: 1
+:patch: 2

data/bin/simp

@@ -0,0 +1,68 @@
+#! /usr/bin/env ruby
+
+  require 'optparse'
+  require 'optparse/time'
+  require 'ostruct'
+  require 'pp'
+  $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+  require 'rsimpy'
+
+  class Simp
+
+
+    #
+    # Return a structure describing the options.
+    #
+    def self.parse(args)
+      # The options specified on the command line will be collected in *options*.
+      # We set default values here.
+      options = OpenStruct.new
+      options.tags = []
+      options.url = ""
+      options.title = ""
+
+      opts = OptionParser.new do |opts|
+        opts.banner = "Usage: example.rb [options]"
+
+        opts.separator ""
+        opts.separator "Specific options:"
+
+        # Mandatory argument.
+        opts.on("-l", "--link URL",
+                "The url to save") do |url|
+          options.url << url
+        end
+
+        # Mandatory argument.
+        opts.on("-n", "--name NAME",
+                "The url to save") do |title|
+          options.title << title
+        end
+
+        # List of arguments.
+        opts.on("-t", "--tags foo,bar,baz", Array, "Tags") do |tags|
+          options.tags = tags
+        end
+
+      end
+
+      opts.parse!(args)
+      options
+    end  # parse()
+
+  end 
+
+  options = Simp.parse(ARGV)
+
+  begin
+    require 'rsimpy'
+
+    links = RSimpy::Links.new
+
+    links.save RSimpy::Parameters.new(:href => options.url, :title => options.title, :tags => options.tags)
+
+  rescue RuntimeError => e
+    puts "An error occured."
+    pp options
+    raise e
+  end

data/features/links/adding_a_link.feature

@@ -0,0 +1,47 @@
+Feature: Post a link to a simpy account
+  In order find a site later
+  As a simpy user
+  I want to post a link to my simpy account via rsimpy
+
+  Scenario: Add a link
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When the "link" is "http://www.example.com"
+    And the "title" is "example"
+    And the "accessType" is ":public"
+    Then I expect to post the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/SaveLink.do?accessType=1&link=http%3A%2F%2Fwww.example.com&src=rsimpy&title=example"
+    And the response is successful
+
+  Scenario: Add a private link
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When the "link" is "http://www.example.com"
+    And the "title" is "example"
+    And the "accessType" is ":private"
+    Then I expect to post the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/SaveLink.do?accessType=0&link=http%3A%2F%2Fwww.example.com&src=rsimpy&title=example"
+    And the response is successful
+
+  Scenario: Add a link with a note
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When the "link" is "http://www.example.com"
+    And the "title" is "example"
+    And the "note" is "Examples are good"
+    And the "accessType" is ":public"
+    Then I expect to post the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/SaveLink.do?accessType=1&link=http%3A%2F%2Fwww.example.com&note=Examples+are+good&src=rsimpy&title=example"
+    And the response is successful
+
+  Scenario: Add a link with tags
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When the "link" is "http://www.example.com"
+    And the "title" is "example"
+    And the "tags" is "foo, bar, cheese"
+    And the "accessType" is ":public"
+    Then I expect to post the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/SaveLink.do?accessType=1&link=http%3A%2F%2Fwww.example.com&src=rsimpy&tags=foo%2C+bar%2C+cheese&title=example"
+    And the response is successful
+
+  Scenario: Add a link with a nickname
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When the "link" is "http://www.example.com"
+    And the "title" is "example"
+    And the "nickname" is "sample"
+    And the "accessType" is ":public"
+    Then I expect to post the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/SaveLink.do?accessType=1&link=http%3A%2F%2Fwww.example.com&nickname=sample&src=rsimpy&title=example"
+    And the response is successful

data/features/links/querying_links.feature

@@ -0,0 +1,46 @@
+Feature: Query links from a simpy account
+  In order find my bookmarks
+  As a simpy user
+  I want to query my simpy account via rsimpy
+ 
+  Scenario: Basic link query
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query the user's links
+    Then I expect to query the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/GetLinks.do?src=rsimpy"
+    Then the links are returned
+    And the response is successful
+
+  Scenario: Querying a tag
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query the user's links
+    And the "q" is "potato"
+    Then I expect to query the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/GetLinks.do?q=potato&src=rsimpy"
+    Then the links are returned
+    And the response is successful
+
+  Scenario: Limiting returned links
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query the user's links
+    And the "limit" is "5"
+    Then I expect to query the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/GetLinks.do?limit=5&src=rsimpy"
+    Then the links are returned
+    And the response is successful
+
+  Scenario: Querying a date
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query the user's links
+    And the "date" is "12/21/2008"
+    Then I expect to query the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/GetLinks.do?date=2008-12-21&src=rsimpy"
+    Then the links are returned
+    And the response is successful
+
+  Scenario: Querying a date range
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query the user's links
+    And the "beforeDate" is "1/2/2009"
+    And the "afterDate" is "1/11/2009"
+    Then I expect to query the url "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/GetLinks.do?afterDate=2009-01-11&beforeDate=2009-01-02&src=rsimpy"
+    Then the links are returned
+    And the response is successful
+
+

data/features/links/steps/link_steps.rb

@@ -0,0 +1,39 @@
+include Responsive
+
+Given /^a user of "([^\"]*)" with a password of "([^\"]*)"$/ do |login, pass|
+  FakeWeb.clean_registry
+  FakeWeb.allow_net_connect=(false)
+
+  @client = RSimpy::Client.new(RSimpy::User.new login, pass)
+  @p = RSimpy::Parameters.new
+end
+
+When /^the "([^\"]*)" is "([^\"]*)"$/ do |key, value|
+  @p[key.to_sym] = convert_symbols_and_dates(key, value)
+end
+
+Then /^I expect to post the url "([^\"]*)"$/ do |url|
+  FakeWeb.register_uri(:post, url, :string => post_response)
+
+  @service = RSimpy::PostingService.new(RSimpy::SAVE_LINK, @client)
+  @response = @service.execute @p
+end
+
+Then /^the response is successful$/ do
+  assert @service.success
+end
+
+When /^I expect to query the url "([^\"]*)"$/ do |url|
+  FakeWeb.register_uri(:get, url, :string => get_response)
+
+  @service = RSimpy::QueryingService.new(RSimpy::GET_LINKS, @client)
+  @response = @service.execute @p
+end
+
+Then /^the links are returned$/ do
+  assert @response.has_key? "links"
+end
+
+When /^I query the user's links$/ do
+  
+end

data/features/notes/query_note.feature

@@ -0,0 +1,27 @@
+Feature: Query notes from my simpy account
+  In order to figure out what I said
+  As a simpy user
+  I want to query notes from my simpy account via rsimpy
+
+  Scenario: Querying notes
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query my notes
+    Then I expect to query the notes with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/GetNotes.do?src=rsimpy"
+    And notes are returned
+    And the response is successful
+
+  Scenario: Querying notes with keyword
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query my notes
+    And the "q" is "goober"
+    Then I expect to query the notes with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/GetNotes.do?q=goober&src=rsimpy"
+    And notes are returned
+    And the response is successful
+
+  Scenario: Querying notes with limit
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I query my notes
+    And the "limit" is "1"
+    Then I expect to query the notes with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/GetNotes.do?limit=1&src=rsimpy"
+    And notes are returned
+    And the response is successful

data/features/notes/remove_note.feature

@@ -0,0 +1,11 @@
+Feature: Remove note from my simpy account
+  In order to clean up my simpy account
+  As a simpy user
+  I want to remove a note from my simpy account via rsimpy
+
+  Scenario: Removing a note
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I remove a user's note
+    And the "noteId" is "1234"
+    Then I expect to remove the note with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/DeleteNote.do?noteId=1234&src=rsimpy"
+    Then the response is successful

data/features/notes/save_note.feature

@@ -0,0 +1,36 @@
+Feature: Save note to my simpy account
+  In order to remember something
+  As a simpy user
+  I want to save a note to my simpy account via rsimpy
+
+  Scenario: Saving a note
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I save a user's note
+    And the "title" is "short note"
+    Then I expect to save the note with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/SaveNote.do?title=short+note&src=rsimpy"
+    And the response is successful
+
+  Scenario: Updating a note
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    And I have a note with the noteId of 1234
+    When I update a user's note
+    And the "title" is "short note"
+    And the "noteId" is "1234"
+    Then I expect to update the note with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/SaveNote.do?noteId=1234&title=short+note&src=rsimpy"
+    And the response is successful
+
+  Scenario: Saving a tagged note
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I update a user's note
+    And the "title" is "short note"
+    And the "tags" is "foo, bar"
+    Then I expect to update the note with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/SaveNote.do?tags=foo%2C+bar&title=short+note&src=rsimpy"
+    And the response is successful
+
+  Scenario: Saving a note with a description
+    Given a user of "USERNAME" with a password of "PASSWORD"
+    When I update a user's note
+    And the "title" is "short note"
+    And the "description" is "thrilling"
+    Then I expect to update the note with the url "http://USERNAME:PASSWORD@www.simpy.com/simpy/api/rest/SaveNote.do?description=thrilling&title=short+note&src=rsimpy"
+    And the response is successful

data/features/notes/steps/note_steps.rb

@@ -0,0 +1,46 @@
+include Responsive
+
+When /^I ([^\"]*) a user's note$/ do |verb|
+
+end
+
+Then /^I expect to remove the note with the url "([^\"]*)"$/ do |url|
+  FakeWeb.register_uri(:post, url, :string => note_removing_response)
+
+  @service = RSimpy::PostingService.new(RSimpy::DELETE_NOTE, @client)
+  @response = @service.execute @p
+end
+
+Then /^I expect to save the note with the url "([^\"]*)"$/ do |url|
+  FakeWeb.register_uri(:post, url, :string => note_saving_response)
+
+  @service = RSimpy::PostingService.new(RSimpy::SAVE_NOTE, @client)
+  @response = @service.execute @p
+end
+
+Given /^I have a note with the noteId of 1234$/ do
+
+end
+
+Then /^I expect to update the note with the url "([^\"]*)"$/ do |url|
+  FakeWeb.register_uri(:post, url, :string => note_saving_response)
+
+  @service = RSimpy::PostingService.new(RSimpy::SAVE_NOTE, @client)
+  @response = @service.execute @p
+end
+
+When /^I query my notes$/ do
+
+end
+
+Then /^I expect to query the notes with the url "([^\"]*)"$/ do |url|
+  FakeWeb.register_uri(:get, url, :string => note_querying_response)
+
+  @service = RSimpy::QueryingService.new(RSimpy::GET_NOTES, @client)
+  @response = @service.execute @p
+end
+
+Then /^notes are returned$/ do
+  assert @response.has_key? 'notes'
+end
+