evernote 0.1.0 → 0.8.0

data/README.mkd

@@ -1,10 +1,48 @@
 # evernote #
-This gem is a high level wrapper around Evernote's Thrift-generated ruby code. It currently just bundles up Evernote's thrift-generated code. After installing, just require the gem in your project:
+This gem is a high level wrapper around Evernote's Thrift-generated ruby code. It bundles up Evernote's thrift-generated code and creates some simple wrapper classes.
 
-require 'evernote'
+# usage #
+Create a config yml:
 
-# future releases #
-This gem will eventually provide a cleaner API around the generated code, so you don't feel like you're writing Java.
+    sandbox:
+      username: user
+      password: password
+      consumer_key: key
+      consumer_secret: secret
+  
+    production:
+      username: user
+      password: password
+      consumer_key: key
+      consumer_secret: secret
+
+Here's an example using the sandbox key:
+
+    require 'evernote'
+
+    user_store_url = "https://sandbox.evernote.com/edam/user"
+    config = File.dirname(__FILE__) + "/config.yml"
+    user_store = Evernote::UserStore.new(user_store_url, config, "sandbox")
+
+    auth_result = user_store.authenticate
+    user = auth_result.user
+    auth_token = auth_result.authenticationToken
+    puts "Authentication was successful for #{user.username}"
+    puts "Authentication token = #{auth_token}"
+
+Once you've authenticated, you could do something like list all of your notebooks:
+
+    note_store_url = "http://sandbox.evernote.com/edam/note/#{user.shardId}"
+    note_store = Evernote::NoteStore.new(note_store_url)
+
+    notebooks = note_store.listNotebooks(auth_token)
+    puts "Found #{notebooks.size} notebooks:"
+    default_notebook = notebooks[0]
+    notebooks.each { |notebook| puts "  * #{notebook.name}"}
+
+The evernote API can be viewed at http://www.evernote.com/about/developer/api/ref/
+
+If the vendored code is out of date and you get an error indicating so, feel free to create an issue at http://github.com/cgs/evernote/issues
 
 ## Copyright ##
 Copyright (c) 2010 Chris Sepic. See LICENSE for details.

data/Rakefile

@@ -9,7 +9,7 @@ begin
     gem.email = "chris.sepic@gmail.com"
     gem.homepage = "http://github.com/cgs/evernote"
     gem.authors = ["Chris Sepic"]
-    gem.files.include %w{vendor/**/*}
+    gem.files.include %w{vendor/**/* spec/evernote/auth.yaml}
     gem.add_dependency("thrift_client")
     gem.add_development_dependency "rspec"
     gem.add_development_dependency "yard"

data/VERSION

@@ -1 +1 @@
-0.1.0
+0.8.0

data/evernote.gemspec

@@ -1,15 +1,15 @@
 # Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
+# 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{evernote}
-  s.version = "0.1.0"
+  s.version = "0.8.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Chris Sepic"]
-  s.date = %q{2010-01-30}
+  s.date = %q{2010-03-19}
   s.email = %q{chris.sepic@gmail.com}
   s.extra_rdoc_files = [
     "LICENSE",
@@ -24,32 +24,26 @@ Gem::Specification.new do |s|
      "VERSION",
      "evernote.gemspec",
      "lib/evernote.rb",
-     "spec/evernote_spec.rb",
+     "lib/evernote/client.rb",
+     "lib/evernote/note_store.rb",
+     "lib/evernote/user_store.rb",
+     "spec/evernote/auth.yaml",
+     "spec/evernote/client_spec.rb",
+     "spec/evernote/note_store_spec.rb",
+     "spec/evernote/user_store_spec.rb",
      "spec/spec.opts",
      "spec/spec_helper.rb",
      "vendor/gen-rb/evernote.rb",
-     "vendor/gen-rb/evernote.rb",
-     "vendor/gen-rb/evernote/edam/errors_types.rb",
      "vendor/gen-rb/evernote/edam/errors_types.rb",
      "vendor/gen-rb/evernote/edam/limits_constants.rb",
-     "vendor/gen-rb/evernote/edam/limits_constants.rb",
      "vendor/gen-rb/evernote/edam/limits_types.rb",
-     "vendor/gen-rb/evernote/edam/limits_types.rb",
-     "vendor/gen-rb/evernote/edam/note_store.rb",
      "vendor/gen-rb/evernote/edam/note_store.rb",
      "vendor/gen-rb/evernote/edam/note_store_constants.rb",
-     "vendor/gen-rb/evernote/edam/note_store_constants.rb",
      "vendor/gen-rb/evernote/edam/note_store_types.rb",
-     "vendor/gen-rb/evernote/edam/note_store_types.rb",
-     "vendor/gen-rb/evernote/edam/types_constants.rb",
      "vendor/gen-rb/evernote/edam/types_constants.rb",
      "vendor/gen-rb/evernote/edam/types_types.rb",
-     "vendor/gen-rb/evernote/edam/types_types.rb",
      "vendor/gen-rb/evernote/edam/user_store.rb",
-     "vendor/gen-rb/evernote/edam/user_store.rb",
-     "vendor/gen-rb/evernote/edam/user_store_constants.rb",
      "vendor/gen-rb/evernote/edam/user_store_constants.rb",
-     "vendor/gen-rb/evernote/edam/user_store_types.rb",
      "vendor/gen-rb/evernote/edam/user_store_types.rb"
   ]
   s.homepage = %q{http://github.com/cgs/evernote}
@@ -58,7 +52,9 @@ Gem::Specification.new do |s|
   s.rubygems_version = %q{1.3.5}
   s.summary = %q{High level wrapper for the Evernote API}
   s.test_files = [
-    "spec/evernote_spec.rb",
+    "spec/evernote/client_spec.rb",
+     "spec/evernote/note_store_spec.rb",
+     "spec/evernote/user_store_spec.rb",
      "spec/spec_helper.rb"
   ]
 
@@ -81,3 +77,4 @@ Gem::Specification.new do |s|
     s.add_dependency(%q<yard>, [">= 0"])
   end
 end
+

data/lib/evernote.rb

@@ -5,3 +5,6 @@ gen_rb_path = File.expand_path(File.dirname(__FILE__) + "/../vendor/gen-rb")
 $LOAD_PATH.unshift gen_rb_path
 $LOAD_PATH.unshift "#{gen_rb_path}/evernote/edam"
 require "#{gen_rb_path}/evernote"
+require "evernote/client"
+require "evernote/user_store"
+require "evernote/note_store"

data/lib/evernote/client.rb

@@ -0,0 +1,17 @@
+module Evernote
+  class Client
+
+    THRIFT_DEFAULTS = {
+      :transport => Thrift::HTTPClientTransport
+    }.freeze
+  
+    def initialize(klass, url, thrift_client_options = {})
+      thrift_opts = THRIFT_DEFAULTS.merge(thrift_client_options)
+      @client = ThriftClient.new(klass, url, thrift_opts)
+    end
+    
+    def method_missing(name, *args, &block)
+      @client.send(name, *args, &block)
+    end
+  end
+end

data/lib/evernote/note_store.rb

@@ -0,0 +1,11 @@
+module Evernote
+  class NoteStore
+    def initialize(uri, thrift_client_options = {})
+      @client = Evernote::Client.new(Evernote::EDAM::NoteStore::NoteStore::Client, uri, thrift_client_options)
+    end
+    
+    def method_missing(name, *args, &block)
+      @client.send(name, *args, &block)
+    end
+  end
+end

data/lib/evernote/user_store.rb

@@ -0,0 +1,43 @@
+module Evernote
+
+  VersionOutOfDate = Class.new(StandardError)
+
+  class UserStore
+    AuthenticationFailure = Class.new(StandardError)
+    
+    def initialize(uri, auth_file, auth_env, thrift_client_options = {})
+      credentials = YAML.load_file(auth_file)[auth_env.to_s]
+      
+      @consumer_key = credentials["consumer_key"]
+      @consumer_secret = credentials["consumer_secret"]
+      @username = credentials["username"]
+      @password = credentials["password"]
+
+      unless @consumer_key && @consumer_secret && @username && @password
+        raise ArgumentError, "'consumer_key', 'consumer_secret', 'username' and 'password' are required"
+      end
+
+      @client = Evernote::Client.new(Evernote::EDAM::UserStore::UserStore::Client, uri, thrift_client_options)
+      
+      validate_version
+    end
+    
+    def authenticate
+      @client.authenticate(@username, @password, @consumer_key, @consumer_secret)
+    rescue Evernote::EDAM::Error::EDAMUserException
+      raise AuthenticationFailure
+    end
+    
+    def method_missing(name, *args, &block)
+      @client.send(name, *args, &block)
+    end
+
+    def validate_version
+      raise VersionOutOfDate, "The vendored Evernote client code is out of date and needs to be regenerated" unless version_valid?
+    end
+
+    def version_valid?
+      checkVersion("Ruby EDAMTest", Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR, Evernote::EDAM::UserStore::EDAM_VERSION_MINOR)
+    end
+  end
+end

data/spec/evernote/auth.yaml

@@ -0,0 +1,11 @@
+sandbox:
+  username: cgs
+  password: password
+  consumer_key: "12345"
+  consumer_secret: ABCDE
+  
+invalid:
+  username: 
+  password:
+  consumer_key:
+  consumer_secret:

data/spec/evernote/client_spec.rb

@@ -0,0 +1,20 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Evernote::Client" do
+  it "initializes a ThriftClient instance that uses HTTP transport" do
+    klass = mock("SomeInternalEvernoteClass")
+    opts = { :transport => Thrift::HTTPClientTransport }
+    ThriftClient.should_receive(:new).with(klass, "https://www.example.com", opts)
+    
+    Evernote::Client.new(klass, "https://www.example.com")
+  end
+  
+  it "should proxy methods" do
+    thrift_client = mock("ThriftClient")
+    ThriftClient.stub!(:new => thrift_client)
+    thrift_client.should_receive(:foobar)
+
+    client = Evernote::Client.new(mock("SomeInternalEvernoteClass"), "https://www.example.com")
+    client.foobar
+  end
+end

data/spec/evernote/note_store_spec.rb

@@ -0,0 +1,10 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Evernote::NoteStore" do
+  it "should proxy methods" do
+    note_store = Evernote::NoteStore.new("http://sandbox.evernote.com/edam/note/")
+    note_store.instance_variable_get(:@client).should_receive(:foobar).and_return(nil)
+    
+    note_store.foobar
+  end
+end

data/spec/evernote/user_store_spec.rb

@@ -0,0 +1,57 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe "Evernote::UserStore" do
+  before(:each) do
+    @auth_file = File.dirname(__FILE__) + "/auth.yaml"
+    @env = :sandbox
+  end
+
+  it "initializes an Evernote::Client and validate the client code version" do
+    client = mock("Evernote::Client", :checkVersion => true)
+    Evernote::Client.should_receive(:new).with(Evernote::EDAM::UserStore::UserStore::Client, "https://sandbox.evernote.com/edam/user", {}).and_return(client)
+  
+    Evernote::UserStore.new("https://sandbox.evernote.com/edam/user", @auth_file, @env)
+  end
+  
+  it "should raise an error on init if the version is not up to date" do
+    Evernote::Client.stub!(:new => mock("Evernote::Client", :checkVersion => false))
+  
+    lambda {
+      Evernote::UserStore.new("https://sandbox.evernote.com/edam/user", @auth_file, @env)
+    }.should raise_error(Evernote::VersionOutOfDate, "The vendored Evernote client code is out of date and needs to be regenerated")
+  end
+
+  %w(consumer_key consumer_secret username password).each do |credential|
+    it "raises an exception if no #{credential} is set" do            
+      lambda {
+        Evernote::UserStore.new("https://sandbox.evernote.com/edam/user", @auth_file, :invalid)
+      }.should raise_error(ArgumentError, "'consumer_key', 'consumer_secret', 'username' and 'password' are required")
+    end
+  end
+  
+  it "should authenticate" do
+    Evernote::Client.stub!(:new => mock("Evernote::Client", :checkVersion => true))
+    user_store = Evernote::UserStore.new("https://sandbox.evernote.com/edam/user", @auth_file, @env)
+    user_store.instance_variable_get(:@client).should_receive(:authenticate).with("cgs", "password", "12345", "ABCDE").and_return(nil)
+    
+    user_store.authenticate
+  end
+  
+  it "should wrap authentication failure" do
+    Evernote::Client.stub!(:new => mock("Evernote::Client", :checkVersion => true))
+    user_store = Evernote::UserStore.new("https://sandbox.evernote.com/edam/user", @auth_file, @env)
+    user_store.instance_variable_get(:@client).should_receive(:authenticate).and_raise(Evernote::EDAM::Error::EDAMUserException)
+    
+    lambda {
+      user_store.authenticate
+    }.should raise_error(Evernote::UserStore::AuthenticationFailure)
+  end
+  
+  it "should proxy methods" do
+    Evernote::Client.stub!(:new => mock("Evernote::Client", :checkVersion => true))
+    user_store = Evernote::UserStore.new("https://sandbox.evernote.com/edam/user", @auth_file, @env)
+    user_store.instance_variable_get(:@client).should_receive(:foobar).and_return(nil)
+    
+    user_store.foobar
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: evernote
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Chris Sepic
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-30 00:00:00 -06:00
+date: 2010-03-19 00:00:00 -05:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -60,7 +60,13 @@ files:
 - VERSION
 - evernote.gemspec
 - lib/evernote.rb
-- spec/evernote_spec.rb
+- lib/evernote/client.rb
+- lib/evernote/note_store.rb
+- lib/evernote/user_store.rb
+- spec/evernote/auth.yaml
+- spec/evernote/client_spec.rb
+- spec/evernote/note_store_spec.rb
+- spec/evernote/user_store_spec.rb
 - spec/spec.opts
 - spec/spec_helper.rb
 - vendor/gen-rb/evernote.rb
@@ -104,5 +110,7 @@ signing_key:
 specification_version: 3
 summary: High level wrapper for the Evernote API
 test_files: 
-- spec/evernote_spec.rb
+- spec/evernote/client_spec.rb
+- spec/evernote/note_store_spec.rb
+- spec/evernote/user_store_spec.rb
 - spec/spec_helper.rb

data/spec/evernote_spec.rb

@@ -1,7 +0,0 @@
-require File.expand_path(File.dirname(__FILE__) + '/spec_helper')
-
-describe "Evernote" do
-  it "fails" do
-    fail "hey buddy, you should probably rename this file and start specing for real"
-  end
-end