CatchNotes_api 0.1.2

data/.document

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

data/.gitignore

@@ -0,0 +1,21 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC

data/CatchNotes_api.gemspec

@@ -0,0 +1,69 @@
+# 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{CatchNotes_api}
+  s.version = "0.1.2"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Wade West"]
+  s.date = %q{2010-11-05}
+  s.description = %q{An ActiveResource like interface to catch.com}
+  s.email = %q{wwest81@gmail.com}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "CatchNotes_api.gemspec",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "lib/catch_notes.rb",
+     "lib/catch_notes/base.rb",
+     "lib/catch_notes/errors.rb",
+     "test/faker.rb",
+     "test/helper.rb",
+     "test/note_class.rb",
+     "test/test_catch_notes.rb"
+  ]
+  s.homepage = %q{http://github.com/wadewest/CatchNotes_api}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{An ActiveResource like interface to catch.com}
+  s.test_files = [
+    "test/faker.rb",
+     "test/helper.rb",
+     "test/note_class.rb",
+     "test/test_catch_notes.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_runtime_dependency(%q<json>, [">= 1.4.6"])
+      s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<sinatra>, [">= 1.1.0"])
+    else
+      s.add_dependency(%q<httparty>, [">= 0.6.1"])
+      s.add_dependency(%q<json>, [">= 1.4.6"])
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<sinatra>, [">= 1.1.0"])
+    end
+  else
+    s.add_dependency(%q<httparty>, [">= 0.6.1"])
+    s.add_dependency(%q<json>, [">= 1.4.6"])
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<sinatra>, [">= 1.1.0"])
+  end
+end
+

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Wade West
+
+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,41 @@
+= CatchNotes_api
+
+== Usage
+
+	# setting up your note class
+	class Note < CatchNotes::Base
+	  username 'foo@example.com'
+	  password 'foobar'
+	end
+	
+	# finding notes
+	notes = Note.all	# returns an array of Note objects
+	first = Note.first	# same as Note.all.first
+	last = Note.last	# same as Note.all.last
+	
+	first.text			# the text content of the note
+	
+	# creating notes
+	note = Note.new :text => "My New Note"
+	note.save 			# will return true if all is good
+	
+	# updating a note
+	note.text = "My Updated Note"
+	note.save
+	
+	# deleting a note
+	note.destroy		# will return true if all is good
+
+== Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+== Copyright
+
+Copyright (c) 2010 Wade West. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,58 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "CatchNotes_api"
+    gem.summary = %Q{An ActiveResource like interface to catch.com}
+    gem.description = %Q{An ActiveResource like interface to catch.com}
+    gem.email = "wwest81@gmail.com"
+    gem.homepage = "http://github.com/wadewest/CatchNotes_api"
+    gem.authors = ["Wade West"]
+    
+    gem.add_dependency 'httparty', '>=0.6.1'
+    gem.add_dependency 'json', '>=1.4.6'
+    
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "sinatra", ">= 1.1.0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+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 :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "CatchNotes_api #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.2

data/lib/catch_notes/base.rb

@@ -0,0 +1,191 @@
+require 'httparty'
+require 'json'
+module CatchNotes
+  class Base
+    
+    attr_reader :id, :created_at, :modified_at, :source, :source_url,
+      :children, :user_name, :user_id
+    attr_accessor :text, :summary, :tags, :reminder_at, :location
+    
+    include HTTParty
+    base_uri "https://api.catch.com/v1"
+    
+    # Methods for Authenication
+    module AuthItems
+      module ClassMethods
+        def username( username )
+          send(:basic_auth, username, get_auth[:password] || '')
+        end
+    
+        def password( password )
+          send(:basic_auth, get_auth[:username] || '', password)
+        end
+      
+        def valid_username?
+          username = get_auth[:username]
+          !(username.nil? || username == '')
+        end
+      
+        def valid_password?
+          password = get_auth[:password]
+          !(password.nil? || password == '')
+        end
+        
+        private
+        def get_auth
+          send(:default_options)[:basic_auth] || {}
+        end
+      end
+      
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+    end
+    
+    # Methods for finding resources
+    module FinderMethods
+      module ClassMethods
+        def all
+          res = get "/notes"
+          if send(:ok?, res)
+            res.parsed_response['notes'].map do |note|
+              send :build_from_hash, note
+            end
+          end
+        end
+    
+        def find(id)
+          res = get "/notes/#{id}"
+          if send(:ok?, res)
+            send :build_from_hash, res.parsed_response['notes'].first
+          end
+        end
+    
+        def first
+          all.first
+        end
+    
+        def last
+          all.last
+        end
+      end
+      
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+    end
+    
+    module CRUDMethods
+      
+      module ClassMethods
+        private
+        def build_from_hash(hash)
+          send :new, hash
+        end
+      end
+      
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+      
+      def initialize(attributes)
+        @attr = self.class.send :stringify_keys, attributes
+        @id = @attr['id']
+        @created_at = @attr['created_at']
+        @modified_at = @attr['modified_at']
+        @source = @attr['source']
+        @source_url = @attr['source_url']
+        @children = @attr['children']
+        @text = @attr['text']
+        @summary = @attr['summary']
+        @tags = @attr['tags']
+        @reminder_at = @attr['reminder_at']
+        @location = @attr['location']
+        unless @attr['user'].nil?
+          @user_name = @attr['user']['user_name']
+          @user_id = @attr['user']['id']
+        end
+      end
+    
+      def save!
+        res = if new_record?
+          self.class.send(:post, "/notes", :body => post_body)
+        else
+          self.class.send(:post, "/notes/#{self.id}", :body => post_body)
+        end
+        if self.class.send(:ok?, res)
+          rebuild res.parsed_response['notes'].first
+        end
+        true
+      end
+      
+      def save
+        save!
+      rescue
+        false
+      end
+    
+      def destroy!
+        raise CatchNotes::NotFound if new_record? # can't delete an unsaved note
+        res = self.class.send(:delete, "/notes/#{self.id}")
+        self.class.send(:ok?, res)
+      end
+    
+      def destroy
+        destroy!
+      rescue
+        false
+      end
+      
+      private
+      def post_body
+        {
+          'text' => send(:text)
+        }.map{|k,v| "#{URI.encode(k)}=#{URI.encode(v)}"}.join("&")
+      end
+      
+      def rebuild(attrs)
+        initialize(attrs)
+      end
+      
+    end
+
+    module Util
+      
+      module ClassMethods
+        def stringify_keys (input_hash)
+          input_hash.map{|k,v| [k.to_s, v]}.inject({}) do |hash, pair|
+            hash[pair.first] = pair.last
+            hash
+          end
+        end
+        
+        private
+        def ok?(response)
+          case response.code
+          when 200 then true
+          when 401 then raise CatchNotes::AuthError
+          when 404 then raise CatchNotes::NotFound
+          else raise CatchNotes::CatchNotesError
+          end
+        end
+      end
+      
+      def new_record?
+        i = self.send :id
+        i.nil?
+      end
+      
+      def self.included(klass)
+        klass.extend ClassMethods
+      end
+      
+    end
+    
+    include AuthItems
+    include FinderMethods
+    include CRUDMethods
+    include Util
+    
+  end
+end

data/lib/catch_notes/errors.rb

@@ -0,0 +1,14 @@
+module CatchNotes
+  
+  # Generic Error
+  class CatchNotesError < StandardError
+  end
+  
+  # 401 response was returned
+  class AuthError < CatchNotesError
+  end
+  
+  # 404 response was returned
+  class NotFound < CatchNotesError
+  end
+end

data/lib/catch_notes.rb

@@ -0,0 +1,5 @@
+require 'catch_notes/errors'
+require 'catch_notes/base'
+module CatchNotes
+  
+end

data/test/faker.rb

@@ -0,0 +1,96 @@
+require 'sinatra/base'
+require 'json'
+module Faker
+  
+  HOST = 'localhost'
+  PORT = 7000
+  
+  class Server < Sinatra::Base
+    
+    use Rack::Auth::Basic do |username, password|
+      [username, password] == ['foo@example.com', 'foobar']
+    end
+    
+    helpers do
+      def build_note(opts = {})
+        opts = {
+          'id' => rand(332422),
+          'text' => "A Note for testing."
+        }.merge(opts)
+        {
+          "browser_url" => "https:\/\/catch.com\/m\/BPTEv\/6Jmd9SKkP0f",
+          "public_url"  => nil,
+          "source"      => "Catch.com",
+          "text"        => opts['text'],
+          "created_at"  => "2010-11-02T15:57:46.919Z",
+          "tags"        => [],
+          "modified_at" => "2010-11-03T13:47:28.674Z",
+          "source_url"  => "https:\/\/catch.com\/",
+          "children"    => 0,
+          "reminder_at" => nil,
+          "location"    => nil,
+          "summary"     => opts['text'].lines.first,
+          "id"          => opts['id'],
+          "user"        => {
+                             "user_name"  => "joe_user",
+                             "id"         => 7923442
+                          }
+        }
+      end
+    end
+    
+    # For getting all notes
+    get "/notes" do
+      content_type 'application/json', :charset => 'utf-8'
+      JSON.generate({
+        'notes' => [
+          build_note('text'=>'Test note one'),
+          build_note('text'=>'Test note two'),
+          build_note('text'=>'Test note three'),
+          build_note('text'=>'Test note four')
+        ]
+      })
+    end
+  
+    # For getting a note by id
+    get %r{/notes/(\d+)} do |id|
+      halt 404 if id.to_i == 13
+      content_type 'application/json', :charset => 'utf-8'
+      JSON.generate({
+        'notes' => [build_note('id'=> id.to_i)]
+      })
+    end
+  
+    # For posting new notes
+    post "/notes" do
+      content_type 'application/json', :charset => 'utf-8'
+      JSON.generate({
+        'notes' => [
+          build_note('text' => params[:text])
+        ]
+      })
+    end  
+    
+    # For posting updates to notes
+    post %r{/notes/(\d+)} do |id|
+      content_type 'application/json', :charset => 'utf-8'
+      JSON.generate({
+        'notes' => [
+          build_note('text' => params[:text], 'id' => params[:id].to_i)
+        ]
+      })
+    end
+    
+    # For deleting a note
+    delete %r{/notes/(\d+)} do |id|
+      halt 404 if id.to_i == 13
+      content_type 'application/json', :charset => 'utf-8'
+      "null"
+    end
+  end
+  
+  Thread.new do
+    Server.run! :host => HOST, :port => PORT.to_i
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,12 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+require 'faker'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'catch_notes'
+
+class Test::Unit::TestCase
+  
+end

data/test/note_class.rb

@@ -0,0 +1,18 @@
+require 'catch_notes'
+require 'faker'
+class NoteClass < CatchNotes::Base
+  base_uri "http://#{Faker::HOST}:#{Faker::PORT}"
+  
+  def self.good_user
+    username "foo@example.com"
+    password "foobar"
+  end
+  
+  def self.bad_user
+    username "bad@example.com"
+    password "foobad"
+  end
+  
+  good_user
+  
+end

data/test/test_catch_notes.rb

@@ -0,0 +1,91 @@
+require 'helper'
+require 'note_class'
+
+class TestCatchNotes < Test::Unit::TestCase
+  
+  def setup
+    NoteClass.good_user
+  end
+  
+  should "have valid login info" do
+    assert_instance_of Class, NoteClass
+    assert NoteClass.valid_username?, "Need a username to connect"
+    assert NoteClass.valid_password?, "Need a password to connect"
+  end
+  
+  should "be able to get all notes as an array of notes" do
+    notes = NoteClass.all
+    assert_instance_of Array, notes
+    assert_instance_of NoteClass, notes.first
+  end
+  
+  should "be able to get the first note" do
+    assert_instance_of NoteClass, NoteClass.first
+  end
+  
+  should "be able to get the last note" do
+    assert_instance_of NoteClass, NoteClass.last
+  end
+  
+  should "be able to find a note by its id" do
+    note = NoteClass.find 42
+    assert_instance_of NoteClass, note
+  end
+  
+  should "be able to create and save a new note" do
+    text = 'This is a new note.'
+    note = NoteClass.new :text=> text
+    assert note.new_record?
+    assert note.save
+    assert !note.new_record?
+    assert_equal text, note.text
+  end
+  
+  should "be able to update an existing note" do
+    note = NoteClass.first
+    note.text= "This is the new text"
+    assert note.save
+  end
+  
+  should "be able to delete a note" do
+    note = NoteClass.first
+    assert_nothing_raised do
+      note.destroy!
+    end
+    assert note.destroy
+  end
+  
+  should "not be able to delete a new note" do
+    note = NoteClass.new :text => "Hello World"
+    assert !note.destroy
+  end
+  
+  should "raise a NotFound error when a note doesn't exist" do
+    assert_raise CatchNotes::NotFound do
+      NoteClass.find 13
+    end
+  end
+  
+  should "not be able to access listing with bad username and password" do
+    NoteClass.bad_user
+    assert_raise CatchNotes::AuthError do
+      NoteClass.all
+    end
+  end
+  
+  should "not allow a bad user to create a note" do
+    NoteClass.bad_user
+    assert_raise CatchNotes::AuthError do
+      NoteClass.new(:text=>"Bad note").save!
+    end
+  end
+  
+  should "not allow a bad user to delete a note" do
+    note = NoteClass.first
+    NoteClass.bad_user
+    assert_raise CatchNotes::AuthError do
+      note.destroy!
+    end
+  end
+  
+end

metadata

@@ -0,0 +1,145 @@
+--- !ruby/object:Gem::Specification 
+name: CatchNotes_api
+version: !ruby/object:Gem::Version 
+  hash: 31
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 2
+  version: 0.1.2
+platform: ruby
+authors: 
+- Wade West
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-05 00:00:00 -05:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 5
+        segments: 
+        - 0
+        - 6
+        - 1
+        version: 0.6.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 1
+        - 4
+        - 6
+        version: 1.4.6
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: thoughtbot-shoulda
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: sinatra
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
+        version: 1.1.0
+  type: :development
+  version_requirements: *id004
+description: An ActiveResource like interface to catch.com
+email: wwest81@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- CatchNotes_api.gemspec
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/catch_notes.rb
+- lib/catch_notes/base.rb
+- lib/catch_notes/errors.rb
+- test/faker.rb
+- test/helper.rb
+- test/note_class.rb
+- test/test_catch_notes.rb
+has_rdoc: true
+homepage: http://github.com/wadewest/CatchNotes_api
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: An ActiveResource like interface to catch.com
+test_files: 
+- test/faker.rb
+- test/helper.rb
+- test/note_class.rb
+- test/test_catch_notes.rb