springpad 0.0.2 → 0.0.3

data/Readme.md

@@ -21,8 +21,19 @@ data:
 ## Usage
 
     $ gem install springpad
+
+Listing notes/tasks:
+
     $ springpad list note
     $ springpad list task
+
+Adding a new note or task:
+
+    $ springpad add note
+    $ (edit with your editor)
+
+Help about the commands:
+
     $ springpad --help
 
 ## Running the tests

data/bin/springpad

@@ -26,13 +26,19 @@ command :list do |c|
 end
 
 command :add do |c|
-  c.syntax = 'springpad add type [options]'
-  c.summary = 'Adds an element of a certain type.'
-  c.description = ''
-  c.example 'description', 'command example'
-  c.option '--some-switch', 'Some switch that does something'
+  c.syntax = 'springpad add TYPE [options]'
+  c.summary = 'Adds an element of a certain TYPE.'
+  c.description = 'Creates a new element of TYPE with custom properties [options]. $EDITOR will be used to create the element. The first line of the element will be its name, the other lines will vary accordying the element type.'
+  c.example 'Create a new private note', 'springpad add note --private'
+  c.option '--private', 'Make the new block private'
   c.action do |args, options|
-    # Do something or c.when_called Springpad::Commands::Add
+    type = args.first
+    unless type
+      warn "A TYPE must be specified. To know about available types, run:"
+      warn "    $ springpad types"
+      abort
+    end
+    Springpad.add(type, options)
   end
 end
 

data/lib/springpad.rb

@@ -23,7 +23,18 @@ module Springpad
     end
   end
 
-  def self.add
+  def self.add(type, options)
+    cli = Springpad::CLI.new
+    options = {}
+    options.merge({:public => false}) if options[:private]
+    contents = cli.edit
 
+    api = Springpad::API.new
+    case type
+    when "note"
+      p api.add_note(contents, options)
+    when "task"
+      p api.add_task(contents, options)
+    end
   end
 end

data/lib/springpad/api.rb

@@ -41,7 +41,65 @@ module Springpad
       get_blocks("Task", filters)
     end
 
+    # Public: Adds a new note to Springpad.
+    #
+    # contents - the Array contents of the note
+    #
+    # Returns the Boolean response.
+    def add_note(contents, options={})
+      note = Blocks::Note.new(contents.first, contents[1..-1].join("\n"))
+      post_block(note)
+    end
+
+    # Public: Adds a new task to Springpad.
+    #
+    # contents - the Array contents of the task
+    #
+    # Returns the Boolean response.
+    def add_task(contents, options={})
+      task = Blocks::Task.new(contents.first, contents[1..-1].join("\n"))
+      post_block(task)
+    end
+
+    # Public: Pushes a block to Springpad.
+    #
+    # contents - the Block to be pushed
+    #
+    # Returns the Boolean response.
+    def post_block(block)
+      shard = get_shard
+
+      JSON.parse(
+        RestClient.post(
+          @url + "/users/me/commands",
+          block.to_params(shard),
+          headers.update({
+            "Content-Type" => "application/json"
+          })
+        )
+      )["success"]
+    end
+
     ## Internal methods: to be extracted
+    #
+    # Internal: Authentication headers to perform API calls.
+    #
+    # Returns the Hash headers.
+    def headers
+      {
+        "X-Spring-Username"  => @user,
+        "X-Spring-Password"  => @password,
+        "X-Spring-Api-Token" => @token,
+      }
+    end
+
+    # Internal: Gets the user shard through an API call.
+    #
+    # Returns the String shard.
+    def get_shard
+      JSON.parse(RestClient.get(@url + "/users/me", headers))["shard"]
+    end
+
 
     # Internal: Gets a collection of blocks of a given type applying some
     # filters.

data/lib/springpad/blocks/note.rb

@@ -1,5 +1,6 @@
 require 'highline'
 require 'stringio'
+require 'securerandom'
 
 module Springpad
   module Blocks
@@ -48,6 +49,20 @@ module Springpad
 #{@text}
 RENDER
       end
+
+      # Public: Creates a query to create a Note in Springpad.
+      #
+      # shard - the String user shard.
+      #
+      # Returns the String JSON commands.
+      def to_params(shard)
+        uuid = "/UUID(#{shard}3#{SecureRandom.uuid[3..-1]})/"
+        [
+          ["create", "Note", uuid],
+          ["set", uuid, "name", @name],
+          ["set", uuid, "text", @text]
+        ].to_json
+      end
     end
   end
 end

data/lib/springpad/blocks/task.rb

@@ -30,7 +30,7 @@ module Springpad
       # name        - the String name
       # description - the String description
       # category    - the String category
-      def initialize(name, description, category)
+      def initialize(name, description, category="")
         @name        = name
         @description = description
         @category    = category
@@ -48,6 +48,21 @@ module Springpad
 #{@description}
 RENDER
       end
+
+      # Public: Creates a query to create a Task in Springpad.
+      #
+      # shard - the String user shard.
+      #
+      # Returns the String JSON commands.
+      def to_params(shard)
+        uuid = "/UUID(#{shard}3#{SecureRandom.uuid[3..-1]})/"
+        [
+          ["create", "Note", uuid],
+          ["set", uuid, "name", @name],
+          ["set", uuid, "description", @description],
+          ["set", uuid, "category", @category]
+        ].to_json
+      end
     end
   end
 end

data/lib/springpad/version.rb

@@ -1,3 +1,3 @@
 module Springpad
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/springpad/api_test.rb

@@ -22,5 +22,38 @@ module Springpad
       tasks.length.must_be :>, 0
       tasks.first.must_be_kind_of Blocks::Task
     end
+
+    it "posts a note" do
+      contents = [
+        "Note title",
+        ["Note body", "yeah"]
+      ]
+
+      api.expects(:post_block).with do |note|
+        note.name.must_equal "Note title"
+        note.text.must_equal "Note body\nyeah"
+      end.returns true
+
+      api.add_note(contents).must_equal true
+    end
+
+    it "posts a task" do
+      contents = [
+        "Task title",
+        ["Task description", "yeah"]
+      ]
+
+      api.expects(:post_block).with do |task|
+        task.name.must_equal "Task title"
+        task.description.must_equal "Task description\nyeah"
+      end.returns true
+
+      api.add_task(contents).must_equal true
+    end
+
+    it 'posts a block' do
+      note = Blocks::Note.new("Note title", "Note body")
+      api.post_block(note).must_equal true
+    end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: springpad
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -13,7 +13,7 @@ date: 2011-12-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &70242399978500 !ruby/object:Gem::Requirement
+  requirement: &70199660179120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242399978500
+  version_requirements: *70199660179120
 - !ruby/object:Gem::Dependency
   name: mocha
-  requirement: &70242399977980 !ruby/object:Gem::Requirement
+  requirement: &70199660178600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -32,10 +32,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242399977980
+  version_requirements: *70199660178600
 - !ruby/object:Gem::Dependency
   name: vcr
-  requirement: &70242399977480 !ruby/object:Gem::Requirement
+  requirement: &70199660178020 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242399977480
+  version_requirements: *70199660178020
 - !ruby/object:Gem::Dependency
   name: webmock
-  requirement: &70242399976500 !ruby/object:Gem::Requirement
+  requirement: &70199660177100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -54,10 +54,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *70242399976500
+  version_requirements: *70199660177100
 - !ruby/object:Gem::Dependency
   name: rest-client
-  requirement: &70242399975780 !ruby/object:Gem::Requirement
+  requirement: &70199660176380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242399975780
+  version_requirements: *70199660176380
 - !ruby/object:Gem::Dependency
   name: commander
-  requirement: &70242399975160 !ruby/object:Gem::Requirement
+  requirement: &70199660175760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :runtime
   prerelease: false
-  version_requirements: *70242399975160
+  version_requirements: *70199660175760
 description: Command-line client for Springpad.
 email:
 - josep.m.bach@gmail.com