CatchNotes_api 0.1.2 → 0.1.3

data/CHANGELOG.rdoc

@@ -0,0 +1,11 @@
+== v0.1.3
+* Added tag listing support.
+* Added searching by tag.
+== v0.1.2
+* Added support for updating a note.
+* Added support for deleting a note.
+== v0.1.1
+* Added support for creating a new note.
+== v0.1.0
+* Added support for listing all notes.
+* Added support for finding a single note by its id.

data/CatchNotes_api.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{CatchNotes_api}
-  s.version = "0.1.2"
+  s.version = "0.1.3"
 
   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.date = %q{2010-11-08}
   s.description = %q{An ActiveResource like interface to catch.com}
   s.email = %q{wwest81@gmail.com}
   s.extra_rdoc_files = [
@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.files = [
     ".document",
      ".gitignore",
+     "CHANGELOG.rdoc",
      "CatchNotes_api.gemspec",
      "LICENSE",
      "README.rdoc",
@@ -27,10 +28,12 @@ Gem::Specification.new do |s|
      "lib/catch_notes.rb",
      "lib/catch_notes/base.rb",
      "lib/catch_notes/errors.rb",
+     "lib/catch_notes/tagging.rb",
      "test/faker.rb",
      "test/helper.rb",
      "test/note_class.rb",
-     "test/test_catch_notes.rb"
+     "test/test_catch_notes.rb",
+     "test/test_tagging.rb"
   ]
   s.homepage = %q{http://github.com/wadewest/CatchNotes_api}
   s.rdoc_options = ["--charset=UTF-8"]
@@ -41,7 +44,8 @@ Gem::Specification.new do |s|
     "test/faker.rb",
      "test/helper.rb",
      "test/note_class.rb",
-     "test/test_catch_notes.rb"
+     "test/test_catch_notes.rb",
+     "test/test_tagging.rb"
   ]
 
   if s.respond_to? :specification_version then
@@ -50,7 +54,7 @@ Gem::Specification.new do |s|
 
     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<json>, [">= 1.4.6"])
       s.add_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
       s.add_development_dependency(%q<sinatra>, [">= 1.1.0"])
     else

data/README.rdoc

@@ -1,6 +1,8 @@
 = CatchNotes_api
 
 == Usage
+	# requiring
+	require 'catch_notes'
 
 	# setting up your note class
 	class Note < CatchNotes::Base
@@ -16,15 +18,27 @@
 	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
+	my_note = Note.new :text => "My New Note"
+	my_note.save 			# will return true if all is good
 	
 	# updating a note
-	note.text = "My Updated Note"
-	note.save
+	my_note.text = "My Updated Note"
+	my_note.save
 	
 	# deleting a note
-	note.destroy		# will return true if all is good
+	my_note.destroy		# will return true if all is good
+	
+	# listing tags
+	Note.tags
+	
+	# finding note by a tag
+	my_notes = Note.find_all_by_tag 'blah'
+	
+	my_note = Note.find_by_tag 'blah'
+
+== Todo
+
+* Add CRUD support for image attachments.
 
 == Note on Patches/Pull Requests
  

data/Rakefile

@@ -12,8 +12,8 @@ begin
     gem.authors = ["Wade West"]
     
     gem.add_dependency 'httparty', '>=0.6.1'
-    gem.add_dependency 'json', '>=1.4.6'
     
+    gem.add_development_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

data/VERSION

@@ -1 +1 @@
-0.1.2
+0.1.3

data/lib/catch_notes/base.rb

@@ -1,5 +1,4 @@
 require 'httparty'
-require 'json'
 module CatchNotes
   class Base
     
@@ -47,18 +46,39 @@ module CatchNotes
       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
+          build_note_array( res.parsed_response['notes'] ) if send(:ok?, res)
         end
     
-        def find(id)
+        def find!(id)
           res = get "/notes/#{id}"
-          if send(:ok?, res)
-            send :build_from_hash, res.parsed_response['notes'].first
-          end
+          send(:build_from_hash,res.parsed_response['notes'].first ) if send(:ok?,res)
+        end
+        
+        def find(id)
+          find!(id)
+        rescue CatchNotes::NotFound
+          nil
+        end
+
+        def find_all_by_tag!( tag_name )
+          res = get "/search?q=%23#{tag_name}"
+          build_note_array( res.parsed_response['notes'] ) if send(:ok?, res)
+        end
+
+        def find_all_by_tag( tag_name )
+          find_all_by_tag!(tag_name)
+        rescue
+          []
+        end
+        
+        def find_by_tag!( tag_name )
+          find_all_by_tag!(tag_name).first
+        end
+        
+        def find_by_tag( tag_name )
+          find_all_by_tag!(tag_name).first
+        rescue
+          nil
         end
     
         def first
@@ -68,6 +88,24 @@ module CatchNotes
         def last
           all.last
         end
+
+        def tags
+          res = get "/tags"
+          if send(:ok?, res)
+            res.parsed_response['tags'].inject({}) do |hash, t|
+              hash[t['name']] = Tagging.new t, self
+              #hash[t['name'].to_sym] = Tagging.new t, self
+              hash
+            end
+          end
+        end
+        
+        private
+        def build_note_array( notes )
+          notes.map do |note|
+            send :build_from_hash, note
+          end
+        end
       end
       
       def self.included(klass)
@@ -137,6 +175,11 @@ module CatchNotes
         false
       end
       
+      def new_record?
+        i = self.send :id
+        i.nil?
+      end
+    
       private
       def post_body
         {
@@ -147,39 +190,8 @@ module CatchNotes
       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

data/lib/catch_notes/tagging.rb

@@ -0,0 +1,19 @@
+require 'httparty'
+module CatchNotes
+  class Tagging
+    
+    def initialize( attrs, creator )
+      @attrs = attrs
+      @creator = creator
+    end
+    
+    def count
+      @attrs['count']
+    end
+    
+    def notes
+      @creator.find_all_by_tag(@attr['name'])
+    end
+    
+  end
+end

data/lib/catch_notes.rb

@@ -1,5 +1,32 @@
-require 'catch_notes/errors'
-require 'catch_notes/base'
 module CatchNotes
-  
+  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 self.included(klass)
+      klass.extend ClassMethods
+    end
+    
+  end
 end
+
+require 'catch_notes/errors'
+require 'catch_notes/base'
+require 'catch_notes/tagging'

data/test/faker.rb

@@ -15,7 +15,8 @@ module Faker
       def build_note(opts = {})
         opts = {
           'id' => rand(332422),
-          'text' => "A Note for testing."
+          'text' => "A Note for testing.",
+          'tags' => []
         }.merge(opts)
         {
           "browser_url" => "https:\/\/catch.com\/m\/BPTEv\/6Jmd9SKkP0f",
@@ -23,7 +24,7 @@ module Faker
           "source"      => "Catch.com",
           "text"        => opts['text'],
           "created_at"  => "2010-11-02T15:57:46.919Z",
-          "tags"        => [],
+          "tags"        => opts['tags'],
           "modified_at" => "2010-11-03T13:47:28.674Z",
           "source_url"  => "https:\/\/catch.com\/",
           "children"    => 0,
@@ -87,6 +88,38 @@ module Faker
       content_type 'application/json', :charset => 'utf-8'
       "null"
     end
+    
+    # For listing tags
+    get "/tags" do
+      content_type 'application/json', :charset => 'utf-8'
+      JSON.generate({
+        'tags' => [
+          { 'count' => 3,
+            'modified' => "2010-11-08T17:29:04.278Z",
+            'name' => 'blah'},
+          { 'count' => 1,
+            'modified' => "2010-11-08T17:29:04.278Z",
+            'name' => 'foo'},
+          { 'count' => 4,
+            'modified' => "2010-11-08T17:29:04.278Z",
+            'name' => 'bar'},
+        ]
+      })
+    end
+    
+    # For searching a tag
+    get '/search' do
+      content_type 'application/json', :charset => 'utf-8'
+      tag = params[:q].gsub(/^#/, '')
+      JSON.generate({
+        'notes' => [
+          build_note('text'=>'Test note one', 'tags' => [tag]),
+          build_note('text'=>'Test note two', 'tags' => [tag]),
+          build_note('text'=>'Test note three', 'tags' => [tag]),
+          build_note('text'=>'Test note four', 'tags' => [tag])
+        ]
+      })
+    end
   end
   
   Thread.new do

data/test/test_catch_notes.rb

@@ -60,9 +60,14 @@ class TestCatchNotes < Test::Unit::TestCase
     assert !note.destroy
   end
   
-  should "raise a NotFound error when a note doesn't exist" do
+  should "raise a nil error when a note doesn't exist: find" do
+    assert_nil NoteClass.find 13
+  end
+  
+  
+  should "raise a NotFound error when a note doesn't exist: find!" do
     assert_raise CatchNotes::NotFound do
-      NoteClass.find 13
+      NoteClass.find! 13
     end
   end
   

data/test/test_tagging.rb

@@ -0,0 +1,25 @@
+require 'helper'
+require 'note_class'
+
+class TestTagging < Test::Unit::TestCase
+  def setup
+    NoteClass.good_user
+  end
+  
+  should "be able to get a list of tags" do
+    assert_instance_of Hash, NoteClass.tags
+  end
+  
+  should "be able to find all notes with a given tag" do
+    notes = NoteClass.find_all_by_tag 'blah'
+    assert_instance_of Array, notes
+    assert_instance_of NoteClass, notes.first
+    assert_equal 'blah', notes.first.tags.first
+  end
+  
+  should "be able to find the first note with a given tag" do
+    note = NoteClass.find_by_tag 'blah'
+    assert_instance_of NoteClass, note
+  end
+  
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: CatchNotes_api
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 0
   - 1
-  - 2
-  version: 0.1.2
+  - 3
+  version: 0.1.3
 platform: ruby
 authors: 
 - Wade West
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-05 00:00:00 -05:00
+date: 2010-11-08 00:00:00 -06:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -48,7 +48,7 @@ dependencies:
         - 4
         - 6
         version: 1.4.6
-  type: :runtime
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: thoughtbot-shoulda
@@ -92,6 +92,7 @@ extra_rdoc_files:
 files: 
 - .document
 - .gitignore
+- CHANGELOG.rdoc
 - CatchNotes_api.gemspec
 - LICENSE
 - README.rdoc
@@ -100,10 +101,12 @@ files:
 - lib/catch_notes.rb
 - lib/catch_notes/base.rb
 - lib/catch_notes/errors.rb
+- lib/catch_notes/tagging.rb
 - test/faker.rb
 - test/helper.rb
 - test/note_class.rb
 - test/test_catch_notes.rb
+- test/test_tagging.rb
 has_rdoc: true
 homepage: http://github.com/wadewest/CatchNotes_api
 licenses: []
@@ -143,3 +146,4 @@ test_files:
 - test/helper.rb
 - test/note_class.rb
 - test/test_catch_notes.rb
+- test/test_tagging.rb