springpad 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in springpad.gemspec
+gemspec

data/Rakefile

@@ -0,0 +1,23 @@
+# encoding: utf-8
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rake/testtask'
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['./test/**/*_test.rb']
+end
+
+desc "Checks the user has appropriate credentials"
+task :check_credentials do
+  begin
+    config = YAML.load(File.read(File.expand_path("~/.springpad")))
+  rescue
+    raise StandardError, "File ~/.springpad does not exist. You must create it in a YAML format with 'user', 'password' and 'token' fields."
+  end
+  unless config['user'] && config['password'] && config['token']
+    raise StandardError, "One of the three fields (either user, password or token) is not filled properly in ~/.springpad. Please check it."
+  end
+end
+
+task :default => [:check_credentials, :test]

data/Readme.md

@@ -0,0 +1,43 @@
+# springpad
+
+Command-line client for [Springpad](http://springpadit.com). Currently WIP.
+
+## Getting an API key
+
+To use this, even to run the tests, you need to be registered at Springpad
+(it's a free service) and also have an API key.
+
+You can [register here](http://springpadit.com/) and [request an API key here](
+http://springpadit.com/developers/oauth/register-app). They give them FAST (I
+got mine the minute after sending the form, no kidding).
+
+After that you have to create a `~/.springpad` file in a YAML format with this
+data:
+
+    user: YOUR_USERNAME
+    password: YOUR_PASSWORD
+    token: YOUR_CONSUMER_KEY
+
+## Usage
+
+    $ gem install springpad
+    $ springpad list note
+    $ springpad list task
+    $ springpad --help
+
+## Running the tests
+
+Once you have the config file in place, you just have to:
+
+    git clone git://github.com/txus/springpad
+    cd springpad
+    bundle install
+    rake
+
+You should see some serious green stuff going on!
+
+## Who's this
+
+This was made by [Josep M. Bach (Txus)](http://txustice.me) under the MIT
+license. I'm [@txustice](http://twitter.com/txustice) on twitter (where you
+should probably follow me!).

data/bin/springpad

@@ -0,0 +1,48 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'commander/import'
+require_relative "../lib/springpad"
+
+program :version, Springpad::VERSION
+program :description, 'Command-line client to the Springpad API.'
+program :help, 'Author', 'Josep M. Bach (Txus) <josep.m.bach@gmail.com>'
+
+command :list do |c|
+  c.syntax = 'springpad list TYPE [options]'
+  c.summary = 'Lists all elements of a certain TYPE.'
+  c.description = 'Springpad blocks have an associated type, for example Note or Task. This command lists every block you own of a certain type. The result can be filtered using [options].'
+  c.example 'List all private notes', 'springpad list note --private'
+  c.option '--private', 'Show only private blocks'
+  c.action do |args, options|
+    type = args.first
+    unless type
+      warn "A TYPE must be specified. To know about available types, run:"
+      warn "    $ springpad types"
+      abort
+    end
+    Springpad.list(type, options)
+  end
+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.action do |args, options|
+    # Do something or c.when_called Springpad::Commands::Add
+  end
+end
+
+command :types do |c|
+  c.syntax = 'springpad types'
+  c.summary = 'Lists the supported element types.'
+  c.description = ''
+  c.action do |args, options|
+    types = Springpad::Blocks.types
+    puts "Supported types are: #{types.join(', ')}"
+  end
+end
+

data/lib/springpad/api.rb

@@ -0,0 +1,124 @@
+require 'rest-client'
+require 'yaml'
+require 'json'
+require 'cgi'
+
+module Springpad
+  # Public: The best way to communicate with the Springpad API.
+  #
+  # Examples
+  #
+  #   api = Springpad::API.new
+  #   api.notes
+  #   # => [..., ..., ...] # Your notes on Springpad
+  #
+  class API
+    # Public: Initializes a new API instance with credentials stored in a
+    # configuration file.
+    def initialize
+      config = YAML.load(File.read(File.expand_path("~/.springpad")))
+      @user     = config['user']
+      @password = config['password']
+      @token    = config['token']
+      @url      = "http://springpadit.com/api"
+    end
+
+    # Public: Gets your notes with optional filters.
+    #
+    # filters - the Hash filters to apply to the search
+    #
+    # Returns an Array of Blocks::Note.
+    def notes(filters={})
+      get_blocks("Note", filters)
+    end
+
+    # Public: Gets your tasks with optional filters.
+    #
+    # filters - the Hash filters to apply to the search
+    #
+    # Returns an Array of Blocks::Task.
+    def tasks(filters={})
+      get_blocks("Task", filters)
+    end
+
+    ## Internal methods: to be extracted
+
+    # Internal: Gets a collection of blocks of a given type applying some
+    # filters.
+    #
+    # type    - the String type of block
+    # filters - the hash filters to apply to the search
+    #
+    # Returns an Array of Blocks::Block.
+    def get_blocks(type, filters)
+      json = get("/users/#{@user}/blocks",
+         :type    => type,
+         :filters => filters)
+
+      Blocks.const_get(type).process(json)
+    end
+
+    # Internal: Performs a GET request on a generated URL using the credentials
+    # from the API instance.
+    #
+    # route   - the String URI of the API resource
+    # options - a Hash of options
+    #
+    # Returns the Hash parsed JSON response.
+    def get(route, options={})
+      url  = generate(route, options)
+      JSON.parse(
+        RestClient.get(
+          url,
+          "X-Spring-Username"  => @user,
+          "X-Spring-Password"  => @password,
+          "X-Spring-Api-Token" => @token
+        )
+      )
+    end
+
+    # Internal: Generates a route and applies some options to it as query
+    # parameters.
+    #
+    # route   - the String URI of the API resource
+    # options - a Hash of options to narrow down the search
+    #
+    # Returns the String generated route.
+    def generate(route, options)
+      base = @url + route
+      return base if options.empty?
+      base += "?"
+      opts = []
+
+      opts << "type=#{options[:type]}" if options[:type]
+      opts << "text=#{options[:matching]}" if options[:matching]
+      opts += extract_filters(options[:filters])
+
+      base += opts.join("&")
+      base
+    end
+
+    # Internal: Extracts filters from a Hash to be encoded as a special form of
+    # query parameter.
+    #
+    # f - the Hash of filters to apply
+    #
+    # Returns the single-element Array with the query parameter.
+    def extract_filters(f)
+      filts = []
+
+      filts << "type=#{f[:type]}" if f[:type]
+      filts << "userAction=#{f[:userAction]}" if f[:userAction]
+      filts << "public=#{f[:public]}" if f[:public]
+      filts << "complete=#{f[:complete]}" if f[:complete]
+      filts << "isInPast=#{f[:isInPast]}" if f[:isInPast]
+      filts << "flagged=#{f[:flagged]}" if f[:flagged]
+
+      if filts.any?
+        ["filter=#{CGI.escape(filts.join(" and "))}"]
+      else
+        []
+      end
+    end
+  end
+end

data/lib/springpad/blocks/note.rb

@@ -0,0 +1,53 @@
+require 'highline'
+require 'stringio'
+
+module Springpad
+  module Blocks
+    # Public: Maps to a Springpad Note block.
+    #
+    # Examples
+    #
+    #   Blocks::Note.process(json_notes)
+    #   # => [#<Blocks::Note>..., #<Blocks::Note...>,]
+    #
+    class Note
+      attr_reader :name, :text
+      # Public: Converts a Hash of JSON note blocks to an Array of actual Note
+      # instances.
+      #
+      # json - the Hash JSON with the note blocks
+      #
+      # Returns an Array of Notes.
+      def self.process(json)
+        json.map do |note|
+          Note.new(
+            note['name'] || "(no title)",
+            note['properties']['text']
+          )
+        end
+      end
+
+      # Internal: Initializes a new Note.
+      #
+      # name - the String name
+      # text - the String text content
+      def initialize(name, text)
+        @name = name
+        @text = text
+      end
+
+      # Public: Renders a note to the standard output.
+      #
+      # Returns nothing.
+      def render
+        out = HighLine.new
+        out.wrap_at = 78
+        out.say <<-RENDER
+<%=color("#{@name}", :bold)%>
+<%='-'*#{@name.length}%>
+#{@text}
+RENDER
+      end
+    end
+  end
+end

data/lib/springpad/blocks/task.rb

@@ -0,0 +1,53 @@
+module Springpad
+  module Blocks
+    # Public: Maps to a Springpad Task block.
+    #
+    # Examples
+    #
+    #   Blocks::Task.process(json_tasks)
+    #   # => [#<Blocks::Task>..., #<Blocks::Task...>,]
+    #
+    class Task
+      attr_reader :name, :description, :category
+      # Public: Converts a Hash of JSON task blocks to an Array of actual Task
+      # instances.
+      #
+      # json - the Hash JSON with the task blocks
+      #
+      # Returns an Array of Tasks.
+      def self.process(json)
+        json.map do |task|
+          Task.new(
+            task['name'],
+            task['properties']['description'],
+            task['properties']['category']['name']
+          )
+        end
+      end
+
+      # Internal: Initializes a new Task.
+      #
+      # name        - the String name
+      # description - the String description
+      # category    - the String category
+      def initialize(name, description, category)
+        @name        = name
+        @description = description
+        @category    = category
+      end
+
+      # Public: Renders a task to the standard output.
+      #
+      # Returns nothing.
+      def render
+        out = HighLine.new
+        out.wrap_at = 78
+        out.say <<-RENDER
+<%=color("#{@name}", :bold)%> [#{@category.upcase}]
+<%='-'*#{@name.length}%>
+#{@description}
+RENDER
+      end
+    end
+  end
+end

data/lib/springpad/blocks.rb

@@ -0,0 +1,14 @@
+module Springpad
+  module Blocks
+    def self.types
+      [
+        "note",
+        "task",
+      ]
+    end
+  end
+end
+
+Springpad::Blocks.types.each do |type|
+  require_relative "blocks/#{type}"
+end

data/lib/springpad/cli.rb

@@ -0,0 +1,15 @@
+require 'tempfile'
+
+module Springpad
+  class CLI
+    # Public: Edits a file with $EDITOR and returns the contents.
+    #
+    # Returns an Array with the first line and an array of the other lines.
+    def edit
+      temp_file = Tempfile.new('block')
+      system("$EDITOR #{temp_file.path}")
+      contents = temp_file.read.chomp.split("\n").reject(&:empty?).map(&:strip)
+      [contents.first, contents[1..-1]]
+    end
+  end
+end

data/lib/springpad/version.rb

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

data/lib/springpad.rb

@@ -0,0 +1,29 @@
+require_relative "springpad/version"
+require_relative "springpad/api"
+require_relative "springpad/blocks"
+require_relative "springpad/cli"
+
+module Springpad
+  def self.list(type, options)
+    api = Springpad::API.new
+    options = {}
+    options.merge({:public => false}) if options[:private]
+    case type
+    when "note"
+      render api.notes(options)
+    when "task"
+      render api.tasks(options)
+    end
+  end
+
+  def self.render(elements)
+    elements.each do |element|
+      element.render
+      puts
+    end
+  end
+
+  def self.add
+
+  end
+end

data/springpad.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "springpad/version"
+
+Gem::Specification.new do |s|
+  s.name        = "springpad"
+  s.version     = Springpad::VERSION
+  s.authors     = ["Josep M. Bach"]
+  s.email       = ["josep.m.bach@gmail.com"]
+  s.homepage    = "http://github.com/txus/springpad"
+  s.summary     = %q{Command-line client for Springpad.}
+  s.description = %q{Command-line client for Springpad.}
+
+  s.rubyforge_project = "springpad"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  # specify any dependencies here; for example:
+  s.add_development_dependency "minitest"
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "vcr"
+  s.add_development_dependency "webmock"
+  s.add_runtime_dependency "rest-client"
+  s.add_runtime_dependency "commander"
+end

data/test/springpad/api_test.rb

@@ -0,0 +1,26 @@
+require 'test_helper'
+
+module Springpad
+  describe API do
+    let(:config) { YAML.load(File.read(File.expand_path("~/.springpad"))) }
+    let(:api) { API.new }
+
+    it 'initializes a user and password from ~/.springpad' do
+      api.instance_variable_get(:@user).must_equal config['user']
+      api.instance_variable_get(:@password).must_equal config['password']
+      api.instance_variable_get(:@token).must_equal config['token']
+    end
+
+    it "fetches the notes of the user" do
+      notes = api.notes(:public => false)
+      notes.length.must_be :>, 0
+      notes.first.must_be_kind_of Blocks::Note
+    end
+
+    it "fetches the tasks of the user" do
+      tasks = api.tasks(:public => false)
+      tasks.length.must_be :>, 0
+      tasks.first.must_be_kind_of Blocks::Task
+    end
+  end
+end

data/test/springpad/blocks/note_test.rb

@@ -0,0 +1,36 @@
+require 'test_helper'
+
+module Springpad::Blocks
+  describe Note do
+    describe '.process' do
+      let(:json) do
+        [
+          {
+            "name" => "Foo",
+            "properties" => {
+              "text" => "Foo bar baz"
+            }
+          },
+
+          {
+            "name" => "Bar",
+            "properties" => {
+              "text" => "Foo bar baz"
+            }
+          }
+        ]
+      end
+
+      it 'processes JSON notes and outputs Note objects' do
+        notes = Note.process(json)
+        notes.length.must_equal 2
+
+        notes.first.name.must_equal "Foo"
+        notes.first.text.must_equal "Foo bar baz"
+
+        notes.last.name.must_equal "Bar"
+        notes.last.text.must_equal "Foo bar baz"
+      end
+    end
+  end
+end

data/test/springpad/blocks/task_test.rb

@@ -0,0 +1,44 @@
+require 'test_helper'
+
+module Springpad::Blocks
+  describe Task do
+    describe '.process' do
+      let(:json) do
+        [
+          {
+            "name" => "Foo",
+            "properties" => {
+              "description" => "Foo bar baz",
+              "category" => {
+                "name" => "Learning"
+              }
+            }
+          },
+
+          {
+            "name" => "Bar",
+            "properties" => {
+              "description" => "Foo bar baz",
+              "category" => {
+                "name" => "Learning"
+              }
+            }
+          }
+        ]
+      end
+
+      it 'processes JSON tasks and outputs Task objects' do
+        tasks = Task.process(json)
+        tasks.length.must_equal 2
+
+        tasks.first.name.must_equal "Foo"
+        tasks.first.description.must_equal "Foo bar baz"
+        tasks.first.category.must_equal "Learning"
+
+        tasks.last.name.must_equal "Bar"
+        tasks.last.description.must_equal "Foo bar baz"
+        tasks.last.category.must_equal "Learning"
+      end
+    end
+  end
+end

data/test/springpad/cli_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+module Springpad
+  describe CLI do
+    describe "#edit" do
+      it 'edits a file and returns the contents' do
+        cli = CLI.new
+
+        Tempfile.stubs(:new).returns file = stub_everything
+        file.stubs(:path).returns "/tmp/something"
+        file.stubs(:read).returns """Name of the task  \n\n This is a description of the task\nThis is more body for the task\n"
+        cli.expects(:system).with("$EDITOR /tmp/something")
+
+        cli.edit.must_equal [
+          "Name of the task",
+          [
+            "This is a description of the task",
+            "This is more body for the task",
+          ]
+        ]
+      end
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,5 @@
+gem 'minitest'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha'
+require_relative '../lib/springpad'

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification
+name: springpad
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Josep M. Bach
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-12-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: &70242399978500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242399978500
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: &70242399977980 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242399977980
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: &70242399977480 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242399977480
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: &70242399976500 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70242399976500
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: &70242399975780 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70242399975780
+- !ruby/object:Gem::Dependency
+  name: commander
+  requirement: &70242399975160 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70242399975160
+description: Command-line client for Springpad.
+email:
+- josep.m.bach@gmail.com
+executables:
+- springpad
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- Rakefile
+- Readme.md
+- bin/springpad
+- lib/springpad.rb
+- lib/springpad/api.rb
+- lib/springpad/blocks.rb
+- lib/springpad/blocks/note.rb
+- lib/springpad/blocks/task.rb
+- lib/springpad/cli.rb
+- lib/springpad/version.rb
+- springpad.gemspec
+- test/springpad/api_test.rb
+- test/springpad/blocks/note_test.rb
+- test/springpad/blocks/task_test.rb
+- test/springpad/cli_test.rb
+- test/test_helper.rb
+homepage: http://github.com/txus/springpad
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: springpad
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: Command-line client for Springpad.
+test_files:
+- test/springpad/api_test.rb
+- test/springpad/blocks/note_test.rb
+- test/springpad/blocks/task_test.rb
+- test/springpad/cli_test.rb
+- test/test_helper.rb