rsimpy 0.1.2

data/lib/posting_service.rb

@@ -0,0 +1,27 @@
+require 'base_service'
+
+module RSimpy
+  MERGE_TAGS = 'MergeTags'
+  SPLIT_TAG = 'SplitTag'
+  RENAME_TAG = "RenameTag"
+  REMOVE_TAG = 'RemoveTag'
+  DELETE_LINK = 'DeleteLink'
+  SAVE_LINK = 'SaveLink'
+  DELETE_NOTE = 'DeleteNote'
+  SAVE_NOTE = 'SaveNote'
+
+  class PostingService < RSimpy::BaseService
+    def initialize command, client
+      @command = command
+      @client = client
+    end
+
+    def execute params
+      execute_using :post, params
+    end
+
+    def build_link params
+      "/#{@command}.do?" << params.to_querystring
+    end
+  end
+end

data/lib/profile_storage_service.rb

@@ -0,0 +1,47 @@
+module RSimpy
+  class  ProfileStorageService                                       
+    def initialize location=nil
+      @location = location || default_location
+    end
+
+    def default_location
+      File.expand_path(File.join(['~','.rsimpy']))
+    end
+
+    def stored?
+      File.exists? @location
+    end
+
+    def save user
+      require 'khayyam'
+
+      topic = Khayyam::Topic.new "rsimpy"
+      topic.regarding "user" do |items|
+        login, pass = user.credentials
+        items["login"] = login
+        items["pass"] = pass
+      end
+
+      output = topic.export
+
+      file = File.open(@location, 'w+')
+      file.write(output)
+      file.close
+    end
+
+    def get
+      file =  File.read(@location)
+      data = {}
+      require 'khayyam'
+      login, pass = nil
+
+      topic = Khayyam::Topic.import file
+      topic.regarding "user" do |items|
+        login = items["login"]
+        pass = items["pass"]
+      end
+
+      return RSimpy::User.new(login, pass)
+    end
+  end
+end 

data/lib/querying_service.rb

@@ -0,0 +1,31 @@
+require 'base_service'
+
+module RSimpy
+  GET_TAGS = "GetTags"
+  GET_LINKS = "GetLinks"
+  GET_NOTES = "GetNotes"
+
+  class QueryingService < RSimpy::BaseService
+
+    def initialize command, client
+      @client = client
+      @command = command
+    end
+    
+    def execute params
+      params = RSimpy::Parameters.new unless params
+
+      reset
+      response = @client.get build_link params
+
+      @success = (response.code == 200)
+
+      response
+    end
+
+    def build_link params
+      params.add(:src, 'rsimpy')
+      "/#{@command}.do?" << params.to_querystring
+    end
+  end
+end

data/lib/rsimpy.rb

@@ -0,0 +1,62 @@
+
+require 'client'
+require 'user'          
+require 'parameters'  
+require 'configuration'
+require 'profile_storage_service'
+require 'posting_service'
+require 'querying_service'
+require 'links'
+require 'errors/user_not_provided_error'
+
+module RSimpy
+  def get_links param_hash={}
+    user = build_user param_hash
+    params = build_params param_hash
+
+    client = RSimpy::Client.new(user)
+    service = RSimpy::QueryingService.new RSimpy::GET_LINKS, client
+
+    result = service.execute params
+    result[:success] = service.success
+    result
+  end
+
+  def delete_link param_hash={}
+    user = build_user param_hash
+
+    client = RSimpy::Client.new(user)
+    service = RSimpy::PostingService.new RSimpy::DELETE_LINK, client
+
+    service.execute param_hash[:params]
+  end
+
+  private
+    def build_user param_hash
+      login = param_hash[:login] if param_hash.has_key? :login
+      pass = param_hash[:pass] if param_hash.has_key? :pass
+
+      if login && pass
+        return RSimpy::User.new login, pass
+      end
+
+      build_user_from_configuration param_hash
+    end
+
+    def build_params param_hash
+      param_hash[:params] || RSimpy::Parameters.new
+    end
+
+    def build_user_from_configuration param_hash
+      storage_service = RSimpy::ProfileStorageService.new(param_hash[:config_file])
+      config = RSimpy::Configuration.new storage_service
+
+      if !config.stored?
+        raise RSimpy::UserNotProvidedError "Please configure RSimpy or supply username and password"
+      end
+
+      config.get
+    end
+end                      
+
+

data/lib/user.rb

@@ -0,0 +1,31 @@
+# encoding: utf-8
+
+# user.rb : Encapsulates Simpy user account information
+#
+# Copyright April 2009, Jamal Hansen. All Rights Reserved.
+#
+# This is free software. Please see the LICENSE files for details.
+module RSimpy
+  # The RSimpy::User class encapsulates user information.
+  #
+  # You can instanciate it with a hash containing login and password
+  #
+  # For example:
+  #
+  #   user = RSimpy::User.new 'login', 'password'
+
+  class User
+    def initialize login, pass
+      @login = login
+      @pass = pass
+    end
+
+    def credentials
+      [@login, @pass]
+    end
+
+    def valid?
+      @login && @pass
+    end
+  end
+end

data/rsimpy.gemspec

@@ -0,0 +1,128 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{rsimpy}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Jamal Hansen"]
+  s.date = %q{2009-12-22}
+  s.default_executable = %q{simp}
+  s.email = %q{jamal.hansen@gmail.com}
+  s.executables = ["simp"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION.yml",
+     "bin/simp",
+     "features/links/adding_a_link.feature",
+     "features/links/querying_links.feature",
+     "features/links/steps/link_steps.rb",
+     "features/notes/query_note.feature",
+     "features/notes/remove_note.feature",
+     "features/notes/save_note.feature",
+     "features/notes/steps/note_steps.rb",
+     "features/support/env.rb",
+     "features/tags/merge_tags.feature",
+     "features/tags/querying_tags.feature",
+     "features/tags/remove_tag.feature",
+     "features/tags/rename_tag.feature",
+     "features/tags/split_tag.feature",
+     "features/tags/steps/tag_steps.rb",
+     "lib/base_service.rb",
+     "lib/client.rb",
+     "lib/configuration.rb",
+     "lib/errors/connection_error.rb",
+     "lib/errors/required_field_missing_error.rb",
+     "lib/errors/user_not_provided_error.rb",
+     "lib/links.rb",
+     "lib/parameters.rb",
+     "lib/posting_service.rb",
+     "lib/profile_storage_service.rb",
+     "lib/querying_service.rb",
+     "lib/rsimpy.rb",
+     "lib/user.rb",
+     "rsimpy.gemspec",
+     "test/client_test.rb",
+     "test/configuration_test.rb",
+     "test/deleting_service_test.rb",
+     "test/fixtures/test",
+     "test/fixtures/user_pass",
+     "test/links_test.rb",
+     "test/parameters_test.rb",
+     "test/posting_service_test.rb",
+     "test/profile_storage_service_test.rb",
+     "test/querying_service_test.rb",
+     "test/r_simpy_test.rb",
+     "test/required_field_missing_error_test.rb",
+     "test/responsive.rb",
+     "test/storage_builder.rb",
+     "test/storage_service_mock.rb",
+     "test/test_helper.rb",
+     "test/user_not_provided_error_test.rb",
+     "test/user_test.rb"
+  ]
+  s.homepage = %q{http://github.com/rubyyot/rsimpy}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{rsimpy}
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{API Wrapper for simpy.com}
+  s.test_files = [
+    "test/storage_service_mock.rb",
+     "test/parameters_test.rb",
+     "test/posting_service_test.rb",
+     "test/deleting_service_test.rb",
+     "test/test_helper.rb",
+     "test/storage_builder.rb",
+     "test/user_test.rb",
+     "test/links_test.rb",
+     "test/responsive.rb",
+     "test/client_test.rb",
+     "test/configuration_test.rb",
+     "test/user_not_provided_error_test.rb",
+     "test/required_field_missing_error_test.rb",
+     "test/querying_service_test.rb",
+     "test/profile_storage_service_test.rb",
+     "test/r_simpy_test.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.4.2"])
+      s.add_runtime_dependency(%q<khayyam>, [">= 0.0.1"])
+      s.add_development_dependency(%q<cucumber>, [">= 0.3.11"])
+      s.add_development_dependency(%q<fakeweb>, [">= 1.2.3"])
+      s.add_development_dependency(%q<shoulda>, [">= 0"])
+      s.add_development_dependency(%q<technicalpickles-jeweler>, [">= 0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.4.2"])
+      s.add_dependency(%q<khayyam>, [">= 0.0.1"])
+      s.add_dependency(%q<cucumber>, [">= 0.3.11"])
+      s.add_dependency(%q<fakeweb>, [">= 1.2.3"])
+      s.add_dependency(%q<shoulda>, [">= 0"])
+      s.add_dependency(%q<technicalpickles-jeweler>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.4.2"])
+    s.add_dependency(%q<khayyam>, [">= 0.0.1"])
+    s.add_dependency(%q<cucumber>, [">= 0.3.11"])
+    s.add_dependency(%q<fakeweb>, [">= 1.2.3"])
+    s.add_dependency(%q<shoulda>, [">= 0"])
+    s.add_dependency(%q<technicalpickles-jeweler>, [">= 0"])
+  end
+end
+

data/test/client_test.rb

@@ -0,0 +1,40 @@
+require 'test_helper'
+require 'fakeweb'
+require 'errors/user_not_provided_error'
+
+
+class ClientTest < Test::Unit::TestCase
+  should "get" do
+    FakeWeb.allow_net_connect = false
+    FakeWeb.register_uri("http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/GetLinks.do", :string => get_response)
+
+    response = RSimpy::Client.new(RSimpy::User.new('USERNAME', 'PASSWORD')).get("/GetLinks.do")
+
+    assert response != nil
+    assert_equal Hash, response['links'].class
+  end
+
+  should "throw user not provided if user !valid?" do
+    begin
+      client = RSimpy::Client.new(InvalidUser.new)
+      flunk "should have thrown UserNotProvidedError"
+    rescue RSimpy::UserNotProvidedError => e
+      assert_equal RSimpy::UserNotProvidedError, e.class
+    end
+  end
+
+  should "throw user not provided if user nil" do
+    begin
+      client = RSimpy::Client.new(nil)
+      flunk "should have thrown UserNotProvidedError"
+    rescue RSimpy::UserNotProvidedError => e
+      assert_equal RSimpy::UserNotProvidedError, e.class
+    end
+  end
+end
+
+class InvalidUser
+  def valid?
+    false
+  end
+end

data/test/configuration_test.rb

@@ -0,0 +1,27 @@
+require 'test_helper'
+require 'storage_builder'
+require 'storage_service_mock'
+
+class ConfigurationTest < Test::Unit::TestCase
+  should "detect stored configuration" do
+    config = RSimpy::Configuration.new StorageBuilder.new.with_stored_configuration('foo', 'bar').build
+    assert config.stored?
+  end
+
+  should "detect missing configuration" do
+    config = RSimpy::Configuration.new StorageBuilder.new.without_stored_configuration.build
+    assert !config.stored?
+  end
+
+  should "save user info" do
+    storage_service = StorageBuilder.new.without_stored_configuration.build
+    config = RSimpy::Configuration.new storage_service
+    config.user = RSimpy::User.new('foo', 'bar')
+
+    assert config.save
+    login, pass = storage_service.user.credentials
+    assert_equal 'foo', login
+    assert_equal 'bar', pass
+  end
+end
+

data/test/deleting_service_test.rb

@@ -0,0 +1,51 @@
+require 'test_helper'
+require 'cgi'
+require 'errors/required_field_missing_error'
+
+class LinkDeletingServiceCanDelete < Test::Unit::TestCase
+  context "deleting" do
+    setup do
+      FakeWeb.clean_registry
+      FakeWeb.allow_net_connect = false
+
+      @client = RSimpy::Client.new(RSimpy::User.new("USERNAME","PASSWORD"))
+      @action = "/DeleteLink.do?"
+    end
+
+    should "build basic link" do
+      params = RSimpy::Parameters.new(:href => "http://www.example.com")
+      link = RSimpy::PostingService.new(RSimpy::DELETE_LINK,
+        @client).build_link(params)
+      assert(/#{@action}/ =~ link)
+    end
+
+    should "delete" do
+      FakeWeb.register_uri(:post, "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/DeleteLink.do?href=http%3A%2F%2Fwww.example.com&src=rsimpy", :string => delete_response)
+
+      service = RSimpy::PostingService.new(RSimpy::DELETE_LINK, @client)
+      response = service.execute RSimpy::Parameters.new(:href => "http://www.example.com")
+      assert service.success
+      assert_equal Hash, response.class
+    end
+
+    should "set src" do
+      params = RSimpy::Parameters.new(:href => "http://www.example.com")
+      link = RSimpy::PostingService.new(RSimpy::DELETE_LINK, @client).build_link(params)
+      assert(/src=rsimpy/ =~ link)
+    end
+  end
+
+  context "link deleting service responses" do
+    should "have a successful response" do
+      FakeWeb.register_uri(:post, "http://USERNAME:PASSWORD@www.simpy.com:80/simpy/api/rest/DeleteLink.do?href=http%3A%2F%2Fexample.com&src=rsimpy", :string => delete_response)
+
+      client = RSimpy::Client.new(RSimpy::User.new("USERNAME","PASSWORD"))
+      service = RSimpy::PostingService.new(RSimpy::DELETE_LINK, client)
+
+      response = service.execute RSimpy::Parameters.new :href => "http://example.com"
+      assert service.success
+      assert_equal "0", service.status_code
+      assert_equal "Link deleted successfully.", service.status_message
+    end
+  end
+end