evernote 0.9.0 → 1.0.0

data/README.mkd

@@ -1,28 +1,25 @@
 # evernote #
 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.
 
+# setup #
+Get yourself a "Client application" API key from Evernote (http://www.evernote.com/about/developer/api/#key), which gives you a "consumer_key" and "consumer_secret" (note that a "web application" API key uses OAuth to authenticate and will not work).  Put the key in a YML file or any other place you put configuration information.  Also, get yourself a username and password on both their sandbox system (http://sandbox.evernote.com) and live system.  You will be using sandbox for testing.
+
 # usage #
-Create a config yml:
-
-    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")
+      
+    config = {
+       :username => 'YOUR_USERNAME',
+       :password => 'YOUR_PASSWORD',
+       :consumer_key => 'YOUR_CONSUMER_KEY_FROM_EVERNOTE',
+       :consumer_secret => 'YOUR_CONSUMER_SECRECT_FROM_EVERNOTE'
+             }
+               
+    # note, you could also read in your consumer key information from a YML file
+    
+    user_store = Evernote::UserStore.new(user_store_url, config)
 
     auth_result = user_store.authenticate
     user = auth_result.user

data/Rakefile

@@ -1,39 +1,16 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "evernote"
-    gem.summary = %Q{High level wrapper for the Evernote API}
-    gem.email = "chris.sepic@gmail.com"
-    gem.homepage = "http://github.com/cgs/evernote"
-    gem.authors = ["Chris Sepic"]
-    gem.files.include %w{vendor/**/* spec/evernote/auth.yaml}
-    gem.add_dependency("thrift_client")
-    gem.add_development_dependency "rspec"
-    gem.add_development_dependency "yard"
-    # 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: sudo gem install jeweler"
-end
-
-require 'spec/rake/spectask'
-Spec::Rake::SpecTask.new(:spec) do |spec|
-  spec.libs << 'lib' << 'spec'
-  spec.spec_files = FileList['spec/**/*_spec.rb']
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = %w{ --colour }
 end
 
-Spec::Rake::SpecTask.new(:rcov) do |spec|
-  spec.libs << 'lib' << 'spec'
+RSpec::Core::RakeTask.new(:rcov) do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = %w{ --colour }
+  spec.rcov_opts = %w{ --exclude gems\/,spec\/ -t}
   spec.rcov = true
 end
 
-task :spec => :check_dependencies
-
 task :default => :spec
 
 begin

data/lib/evernote/user_store.rb

@@ -5,13 +5,16 @@ module Evernote
   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]
+    def initialize(uri, credentials, thrift_client_options = {})
       
-      @consumer_key = credentials["consumer_key"]
-      @consumer_secret = credentials["consumer_secret"]
-      @username = credentials["username"]
-      @password = credentials["password"]
+      raise ArgumentError, "credentials must be passed in as a hash" unless credentials.class == Hash
+      
+      credentials=credentials.inject({}) { |h,(k,v)| h[k.to_sym] = v; h } # convert any stringifyed hash keys into symbols
+      
+      @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"

data/lib/evernote/version.rb

@@ -0,0 +1,3 @@
+module Evernote
+  VERSION = "1.0.0"
+end

data/spec/evernote/user_store_spec.rb

@@ -2,44 +2,54 @@ 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
+    @user_store_url = "https://sandbox.evernote.com/edam/user" 
+    @config = {
+      :username => 'cgs',
+      :password => 'password',
+      :consumer_key => '12345',
+      :consumer_secret => 'ABCDE'
+    }    
   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)
+    Evernote::UserStore.new(@user_store_url, @config)
   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)
+        Evernote::UserStore.new(@user_store_url, @config)
     }.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)
+        Evernote::UserStore.new(@user_store_url, Hash.new)
       }.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=Evernote::UserStore.new(@user_store_url, @config)
     user_store.instance_variable_get(:@client).should_receive(:authenticate).with("cgs", "password", "12345", "ABCDE").and_return(nil)
     
     user_store.authenticate
   end
   
+  it "should raise an exception if the config parameter is not a hash" do
+    not_a_hash="hello, I am a string"
+    lambda {Evernote::UserStore.new(@user_store_url, not_a_hash)}.should raise_error(ArgumentError, "credentials must be passed in as a hash")    
+  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=Evernote::UserStore.new(@user_store_url, @config)
     user_store.instance_variable_get(:@client).should_receive(:authenticate).and_raise(Evernote::EDAM::Error::EDAMUserException)
     
     lambda {
@@ -49,7 +59,7 @@ describe "Evernote::UserStore" do
   
   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=Evernote::UserStore.new(@user_store_url, @config)
     user_store.instance_variable_get(:@client).should_receive(:foobar).and_return(nil)
     
     user_store.foobar

data/spec/spec_helper.rb

@@ -1,9 +1,9 @@
 $LOAD_PATH.unshift(File.dirname(__FILE__))
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 require 'evernote'
-require 'spec'
-require 'spec/autorun'
+require 'rspec'
+require 'yaml'
 
-Spec::Runner.configure do |config|
+RSpec.configure do |config|
   
 end

metadata

@@ -1,93 +1,68 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: evernote
-version: !ruby/object:Gem::Version 
-  hash: 59
-  prerelease: false
-  segments: 
-  - 0
-  - 9
-  - 0
-  version: 0.9.0
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+  prerelease: 
 platform: ruby
-authors: 
+authors:
 - Chris Sepic
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-01-23 00:00:00 -06:00
+date: 2011-06-28 00:00:00.000000000 -05:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+dependencies:
+- !ruby/object:Gem::Dependency
   name: thrift_client
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &2165422040 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: rspec
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *2165422040
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &2165421580 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id002
-- !ruby/object:Gem::Dependency 
-  name: yard
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  version_requirements: *2165421580
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: &2165421160 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 3
-        segments: 
-        - 0
-        version: "0"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
   type: :development
-  version_requirements: *id003
-description: 
-email: chris.sepic@gmail.com
+  prerelease: false
+  version_requirements: *2165421160
+description: 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.
+email:
+- chris.sepic@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- LICENSE
-- README.mkd
-files: 
-- .document
-- .gitignore
-- LICENSE
-- README.mkd
-- Rakefile
-- VERSION
-- evernote.gemspec
-- lib/evernote.rb
+extra_rdoc_files: []
+files:
 - lib/evernote/client.rb
 - lib/evernote/note_store.rb
 - lib/evernote/user_store.rb
+- lib/evernote/version.rb
+- lib/evernote.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/edam/errors_types.rb
 - vendor/gen-rb/evernote/edam/limits_constants.rb
 - vendor/gen-rb/evernote/edam/limits_types.rb
@@ -99,42 +74,34 @@ files:
 - vendor/gen-rb/evernote/edam/user_store.rb
 - vendor/gen-rb/evernote/edam/user_store_constants.rb
 - vendor/gen-rb/evernote/edam/user_store_types.rb
+- vendor/gen-rb/evernote.rb
+- LICENSE
+- README.mkd
+- Rakefile
+- .gitignore
 has_rdoc: true
 homepage: http://github.com/cgs/evernote
 licenses: []
-
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
+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 
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
-  requirements: 
-  - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.3.7
+rubygems_version: 1.6.2
 signing_key: 
 specification_version: 3
 summary: High level wrapper for the Evernote API
-test_files: 
-- spec/evernote/client_spec.rb
-- spec/evernote/note_store_spec.rb
-- spec/evernote/user_store_spec.rb
-- spec/spec_helper.rb
+test_files: []

data/.document

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

data/VERSION

@@ -1 +0,0 @@
-0.9.0

data/evernote.gemspec

@@ -1,92 +0,0 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE
-# Instead, edit Jeweler::Tasks in Rakefile, and run `rake gemspec`
-# -*- encoding: utf-8 -*-
-
-Gem::Specification.new do |s|
-  s.name = %q{evernote}
-  s.version = "0.9.0"
-
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Chris Sepic"]
-  s.date = %q{2011-01-23}
-  s.email = %q{chris.sepic@gmail.com}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.mkd"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.mkd",
-     "Rakefile",
-     "VERSION",
-     "evernote.gemspec",
-     "lib/evernote.rb",
-     "lib/evernote/client.rb",
-     "lib/evernote/note_store.rb",
-     "lib/evernote/user_store.rb",
-     "spec/evernote/auth.yaml",
-     "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}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{High level wrapper for the Evernote API}
-  s.test_files = [
-    "spec/evernote/client_spec.rb",
-     "spec/evernote/note_store_spec.rb",
-     "spec/evernote/user_store_spec.rb",
-     "spec/spec_helper.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<thrift_client>, [">= 0"])
-      s.add_development_dependency(%q<rspec>, [">= 0"])
-      s.add_development_dependency(%q<yard>, [">= 0"])
-    else
-      s.add_dependency(%q<thrift_client>, [">= 0"])
-      s.add_dependency(%q<rspec>, [">= 0"])
-      s.add_dependency(%q<yard>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<thrift_client>, [">= 0"])
-    s.add_dependency(%q<rspec>, [">= 0"])
-    s.add_dependency(%q<yard>, [">= 0"])
-  end
-end

data/spec/spec.opts

@@ -1,2 +0,0 @@
---colour
---diff