evernote_oauth 0.0.1

data/LICENSE

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) 2007-2012 by Evernote Corporation, All rights reserved.
+ *
+ * Use of the source code and binary libraries included in this package
+ * is permitted under the following terms:
+ *
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions of source code must retain the above copyright
+ *    notice, this list of conditions and the following disclaimer.
+ * 2. Redistributions in binary form must reproduce the above copyright
+ *    notice, this list of conditions and the following disclaimer in the
+ *    documentation and/or other materials provided with the distribution.
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+ * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+ * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+ * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+ * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.    
+ */

data/README.md

@@ -0,0 +1,58 @@
+Evernote OAuth / Thrift API client library for Ruby
+===================================================
+Evernote OAuth version 0.01
+Evernote API version 1.21
+
+Install the gem
+---------------
+gem install evernote_oauth
+
+Prerequisites
+-------------
+In order to use the code in this SDK, you need to obtain an API key from http://dev.evernote.com/documentation/cloud. You'll also find full API documentation on that page.
+
+In order to run the sample code, you need a user account on the sandbox service where you will do your development. Sign up for an account at https://sandbox.evernote.com/Registration.action 
+
+In order to run the client client sample code, you need a developer token. Get one at https://sandbox.evernote.com/api/DeveloperToken.action
+
+Setup
+-----
+Put your API keys in the config/evernote.yml
+```ruby
+development:
+  consumer_key: YOUR CONSUMER KEY
+  consumer_secret: YOUR CONSUMER SECRET
+  sandbox: [true or false]
+```
+Or you can just pass those information when you create an instance of the client
+```ruby
+client = EvernoteOAuth::Client.new(
+  consumer_key: YOUR CONSUMER KEY
+  consumer_secret: YOUR CONSUMER SECRET
+  sandbox: [true or false]
+)
+```
+
+Usage
+-----
+```ruby
+client = EvernoteOAuth::Client.new
+request_token = client.request_token(:oauth_callback => 'YOUR CALLBACK URL')
+request_token.authorize_url
+ => https://sandbox.evernote.com/OAuth.action?oauth_token=OAUTH_TOKEN
+```
+To obtain the access token
+```ruby
+access_token = request_token.get_access_token(oauth_verifier: params[:oauth_verifier])
+```
+Now you can make other API calls
+```ruby
+client = EvernoteOAuth::Client.new(token: access_token.token)
+note_store = client.note_store
+notebooks = note_store.listNotebooks(access_token.token)
+```
+
+References
+----------
+- Evernote Developers: http://dev.evernote.com/
+- API Document: http://dev.evernote.com/documentation/reference/

data/evernote_oauth.gemspec

@@ -0,0 +1,32 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib/', __FILE__)
+$LOAD_PATH.unshift lib unless $LOAD_PATH.include?(lib)
+
+require 'evernote_oauth/version'
+
+Gem::Specification.new do |s|
+  s.name = %q{evernote_oauth}
+  s.version = EvernoteOAuth::VERSION
+
+  s.authors = ["Kentaro Suzuki"]
+  s.date = %q{2012-08-14}
+  s.description = %q{evernote_oauth is a Ruby client for the Evernote API using OAuth and Thrift.}
+  s.email = %q{ksuzuki@gmail.com}
+  s.files = ["LICENSE", "README.md", "evernote_oauth.gemspec"] + Dir.glob('{lib,spec,vendor}/**/*')
+  s.has_rdoc = false
+  s.homepage = %q{http://github.com/rekotan/evernote_oauth}
+  s.rdoc_options = ["--inline-source", "--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{evernote_oauth}
+  s.rubygems_version = %q{0.0.1}
+  s.summary = %q{evernote_oauth is a Ruby client for the Evernote API using OAuth and Thrift.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 2
+
+    s.add_dependency 'oauth', '>= 0.4.1'
+    s.add_dependency 'thrift_client', '>= 0.8.1'
+    s.add_development_dependency 'rspec'
+  end
+end

data/lib/evernote_oauth.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+require 'thrift_client'
+require 'oauth'
+require 'yaml'
+
+vendor_path = File.expand_path(File.dirname(__FILE__) + "/../vendor")
+$LOAD_PATH.unshift "#{vendor_path}/evernote/edam"
+
+require "#{vendor_path}/evernote"
+
+require 'evernote_oauth/client'
+require 'evernote_oauth/user_store'
+require 'evernote_oauth/note_store'
+require 'evernote_oauth/version'
+
+# Path Thrift 0.8.0 Gem for Ruby 1.9.3 compatibility
+# See: http://discussion.evernote.com/topic/15321-evernote-ruby-thrift-client-error/
+#
+if Gem::Version.new(RUBY_VERSION.dup) == Gem::Version.new('1.9.3') &&
+  Gem.loaded_specs['thrift'].version == Gem::Version.new('0.8.0')
+  module Thrift
+    class HTTPClientTransport < BaseTransport
+
+      def flush
+	http = Net::HTTP.new @url.host, @url.port
+	http.use_ssl = @url.scheme == "https"
+	resp, data = http.post(@url.request_uri, @outbuf, @headers)
+	# Was: @inbuf = StringIO.new data
+	@inbuf = StringIO.new resp.body
+	@outbuf = ""
+      end
+    end
+  end
+end

data/lib/evernote_oauth/client.rb

@@ -0,0 +1,65 @@
+module EvernoteOAuth
+  class Client
+
+    def initialize(options={})
+      config_file = "config/evernote.yml"
+      if File.exist?(config_file)
+	config = YAML.load(ERB.new(File.read(config_file)).result)[Rails.env]
+	@consumer_key = config['consumer_key']
+	@consumer_secret = config['consumer_secret']
+	@sandbox = config['sandbox'] ? true : false
+      end
+
+      @consumer_key ||= options[:consumer_key]
+      @consumer_secret ||= options[:consumer_secret]
+      @sandbox ||= (options[:sandbox] == nil ? true : options[:sandbox])
+      @token = options[:token]
+      @secret = options[:secret]
+    end
+
+    def authorize(token, secret, options={})
+      request_token = OAuth::RequestToken.new(consumer, token, secret)
+      @access_token = request_token.get_access_token(options)
+      @token = @access_token.token
+      @secret = @access_token.secret
+      @access_token
+    end
+
+    def request_token(options={})
+      consumer.get_request_token(options)
+    end
+
+    def authentication_request_token(options={})
+      consumer.options[:authorize_path] = '/OAuth.action'
+      request_token(options)
+    end
+
+    private
+      def consumer
+        @consumer ||= OAuth::Consumer.new(
+          @consumer_key,
+          @consumer_secret,
+          {site: endpoint,
+            request_token_path: "/oauth",
+            access_token_path: "/oauth"}
+        )
+      end
+
+      def endpoint(path=nil)
+        url = @sandbox ? "https://sandbox.evernote.com" : "https://www.evernote.com"
+	url += "/#{path}" if path
+	url
+      end
+
+      def access_token
+	@access_token ||= OAuth::AccessToken.new(consumer, @token, @secret)
+      end
+
+      def thrift_client(client_class, url, options={})
+	@thrift_client = ThriftClient.new(client_class, url, options.merge(
+          transport: Thrift::HTTPClientTransport))
+      end
+
+  end
+end
+

data/lib/evernote_oauth/note_store.rb

@@ -0,0 +1,23 @@
+module EvernoteOAuth
+
+  class Client
+    def note_store(options={})
+      @note_store = EvernoteOAuth::NoteStore.new(
+	client: thrift_client(::Evernote::EDAM::NoteStore::NoteStore::Client,
+			      user_store(options).getNoteStoreUrl(@token),
+			      options)
+      )
+    end
+  end
+
+  class NoteStore
+    def initialize(options={})
+      @client = options[:client]
+    end
+
+    def method_missing(name, *args, &block)
+      @client.send(name, *args, &block)
+    end
+  end
+
+end

data/lib/evernote_oauth/user_store.rb

@@ -0,0 +1,29 @@
+module EvernoteOAuth
+
+  class Client
+    def user_store(options={})
+      @user_store = EvernoteOAuth::UserStore.new(
+	client: thrift_client(::Evernote::EDAM::UserStore::UserStore::Client,
+			      endpoint('edam/user'), options)
+      )
+    end
+  end
+
+  class UserStore
+    def initialize(options={})
+      @client = options[:client]
+      raise 'API version is not up to date' unless version_valid?
+    end
+
+    def method_missing(name, *args, &block)
+      @client.send(name, *args, &block)
+    end
+
+    def version_valid?
+      checkVersion("EDAMTest",
+                   ::Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR,
+                   ::Evernote::EDAM::UserStore::EDAM_VERSION_MINOR)
+    end
+  end
+
+end

data/lib/evernote_oauth/version.rb

@@ -0,0 +1,3 @@
+module EvernoteOAuth
+  VERSION = "0.0.1"
+end

data/spec/evernote_oauth/client_spec.rb

@@ -0,0 +1,55 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "EvernoteOAuth::Client" do
+  before :each do
+    @client = EvernoteOAuth::Client.new(
+      consumer_key: 'consumer_key',
+      consumer_secret: 'consumer_secret',
+      sandbox: false,
+      token: 'token',
+      secret: 'secret'
+    )
+  end
+  context "#initialize" do
+    it "assigns instance variables" do
+      @client.instance_variable_get(:@consumer_key).should == 'consumer_key'
+      @client.instance_variable_get(:@consumer_secret).should == 'consumer_secret'
+      @client.instance_variable_get(:@sandbox).should == false
+      @client.instance_variable_get(:@token).should == 'token'
+      @client.instance_variable_get(:@secret).should == 'secret'
+    end
+  end
+  context "#authorize" do
+    it "assigns returns access token" do
+      mock_access_token = mock(OAuth::AccessToken)
+      mock_access_token.should_receive(:token).and_return('token')
+      mock_access_token.should_receive(:secret).and_return('secret')
+      mock_request_token = mock(OAuth::RequestToken)
+      mock_request_token.should_receive(:get_access_token).and_return(mock_access_token)
+      OAuth::RequestToken.stub(:new){mock_request_token}
+
+      @client.authorize('token', 'secret').should == mock_access_token
+    end
+  end
+  context "#request_token" do
+    it "calls OAuth::Consumer#get_request_token" do
+      mock_request_token = mock(OAuth::RequestToken)
+      mock_consumer = mock(OAuth::Consumer)
+      mock_consumer.should_receive(:get_request_token).and_return(mock_request_token)
+      @client.should_receive(:consumer).and_return(mock_consumer)
+      @client.request_token.should == mock_request_token
+    end
+  end
+  context "#authentication_request_token" do
+    it "calls request_token with 'authorize_path' options" do
+      option = {}
+      mock_request_token = mock(OAuth::RequestToken)
+      mock_consumer = mock(OAuth::Consumer)
+      mock_consumer.should_receive(:options).and_return(option)
+      @client.should_receive(:consumer).and_return(mock_consumer)
+      @client.should_receive(:request_token).and_return(mock_request_token)
+      @client.authentication_request_token.should == mock_request_token
+      option[:authorize_path].should == '/OAuth.action'
+    end
+  end
+end

data/spec/evernote_oauth/note_store_spec.rb

@@ -0,0 +1,18 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "EvernoteOAuth::NoteStore" do
+  context "#initialize" do
+    it "assigns instance variables and checks version" do
+      note_store = EvernoteOAuth::NoteStore.new(client: 'client')
+      note_store.instance_variable_get(:@client).should == 'client'
+    end
+  end
+  context "#method_missing" do
+    it "dispatches method" do
+      mock_client = mock(Object)
+      mock_client.should_receive(:send).with(:call_method, 'args')
+      note_store = EvernoteOAuth::NoteStore.new(client: mock_client)
+      note_store.call_method('args')
+    end
+  end
+end

data/spec/evernote_oauth/user_store_spec.rb

@@ -0,0 +1,24 @@
+require File.join(File.dirname(__FILE__), "/../spec_helper")
+
+describe "EvernoteOAuth::UserStore" do
+  context "#initialize" do
+    it "assigns instance variables and checks version" do
+      EvernoteOAuth::UserStore.any_instance.stub(:version_valid?){true}
+      user_store = EvernoteOAuth::UserStore.new(client: 'client')
+      user_store.instance_variable_get(:@client).should == 'client'
+    end
+    it "raises error when version is not valid" do
+      EvernoteOAuth::UserStore.any_instance.stub(:version_valid?){false}
+      lambda{EvernoteOAuth::UserStore.new(client: 'client')}.should raise_error
+    end
+  end
+  context "#method_missing" do
+    it "dispatches method" do
+      mock_client = mock(Object)
+      mock_client.should_receive(:send).with(:call_method, 'args')
+      EvernoteOAuth::UserStore.any_instance.stub(:version_valid?){true}
+      user_store = EvernoteOAuth::UserStore.new(client: mock_client)
+      user_store.call_method('args')
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'evernote_oauth'
+require 'rspec'
+
+Dir.glob(File.join(File.join(File.dirname(__FILE__), "..", "lib"), "**")).each do |file|
+  require file
+end

data/vendor/evernote.rb

@@ -0,0 +1,12 @@
+require 'set'
+require 'errors_types'
+require 'limits_constants'
+require 'limits_types'
+require 'note_store'
+require 'note_store_constants'
+require 'note_store_types'
+require 'types_constants'
+require 'types_types'
+require 'user_store'
+require 'user_store_constants'
+require 'user_store_types'

data/vendor/evernote/edam/errors_constants.rb

@@ -0,0 +1,14 @@
+#
+# Autogenerated by Thrift Compiler (0.8.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+require 'errors_types'
+
+      module Evernote
+        module EDAM
+          module Error
+    end
+  end
+end

data/vendor/evernote/edam/errors_types.rb

@@ -0,0 +1,128 @@
+#
+# Autogenerated by Thrift Compiler (0.8.0)
+#
+# DO NOT EDIT UNLESS YOU ARE SURE THAT YOU KNOW WHAT YOU ARE DOING
+#
+
+
+module Evernote
+  module EDAM
+    module Error
+            module EDAMErrorCode
+              UNKNOWN = 1
+              BAD_DATA_FORMAT = 2
+              PERMISSION_DENIED = 3
+              INTERNAL_ERROR = 4
+              DATA_REQUIRED = 5
+              LIMIT_REACHED = 6
+              QUOTA_REACHED = 7
+              INVALID_AUTH = 8
+              AUTH_EXPIRED = 9
+              DATA_CONFLICT = 10
+              ENML_VALIDATION = 11
+              SHARD_UNAVAILABLE = 12
+              LEN_TOO_SHORT = 13
+              LEN_TOO_LONG = 14
+              TOO_FEW = 15
+              TOO_MANY = 16
+              UNSUPPORTED_OPERATION = 17
+              VALUE_MAP = {1 => "UNKNOWN", 2 => "BAD_DATA_FORMAT", 3 => "PERMISSION_DENIED", 4 => "INTERNAL_ERROR", 5 => "DATA_REQUIRED", 6 => "LIMIT_REACHED", 7 => "QUOTA_REACHED", 8 => "INVALID_AUTH", 9 => "AUTH_EXPIRED", 10 => "DATA_CONFLICT", 11 => "ENML_VALIDATION", 12 => "SHARD_UNAVAILABLE", 13 => "LEN_TOO_SHORT", 14 => "LEN_TOO_LONG", 15 => "TOO_FEW", 16 => "TOO_MANY", 17 => "UNSUPPORTED_OPERATION"}
+              VALID_VALUES = Set.new([UNKNOWN, BAD_DATA_FORMAT, PERMISSION_DENIED, INTERNAL_ERROR, DATA_REQUIRED, LIMIT_REACHED, QUOTA_REACHED, INVALID_AUTH, AUTH_EXPIRED, DATA_CONFLICT, ENML_VALIDATION, SHARD_UNAVAILABLE, LEN_TOO_SHORT, LEN_TOO_LONG, TOO_FEW, TOO_MANY, UNSUPPORTED_OPERATION]).freeze
+            end
+
+            # This exception is thrown by EDAM procedures when a call fails as a result of
+            # a problem that a user may be able to resolve.  For example, if the user
+            # attempts to add a note to their account which would exceed their storage
+            # quota, this type of exception may be thrown to indicate the source of the
+            # error so that they can choose an alternate action.
+            # 
+            # This exception would not be used for internal system errors that do not
+            # reflect user actions, but rather reflect a problem within the service that
+            # the user cannot resolve.
+            # 
+            # errorCode:  The numeric code indicating the type of error that occurred.
+            #   must be one of the values of EDAMErrorCode.
+            # 
+            # parameter:  If the error applied to a particular input parameter, this will
+            #   indicate which parameter.
+            class EDAMUserException < ::Thrift::Exception
+              include ::Thrift::Struct, ::Thrift::Struct_Union
+              ERRORCODE = 1
+              PARAMETER = 2
+
+              FIELDS = {
+                ERRORCODE => {:type => ::Thrift::Types::I32, :name => 'errorCode', :enum_class => Evernote::EDAM::Error::EDAMErrorCode},
+                PARAMETER => {:type => ::Thrift::Types::STRING, :name => 'parameter', :optional => true}
+              }
+
+              def struct_fields; FIELDS; end
+
+              def validate
+                raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field errorCode is unset!') unless @errorCode
+                unless @errorCode.nil? || Evernote::EDAM::Error::EDAMErrorCode::VALID_VALUES.include?(@errorCode)
+                  raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Invalid value of field errorCode!')
+                end
+              end
+
+              ::Thrift::Struct.generate_accessors self
+            end
+
+            # This exception is thrown by EDAM procedures when a call fails as a result of
+            # an a problem in the service that could not be changed through user action.
+            # 
+            # errorCode:  The numeric code indicating the type of error that occurred.
+            #   must be one of the values of EDAMErrorCode.
+            # 
+            # message:  This may contain additional information about the error
+            class EDAMSystemException < ::Thrift::Exception
+              include ::Thrift::Struct, ::Thrift::Struct_Union
+              ERRORCODE = 1
+              MESSAGE = 2
+
+              FIELDS = {
+                ERRORCODE => {:type => ::Thrift::Types::I32, :name => 'errorCode', :enum_class => Evernote::EDAM::Error::EDAMErrorCode},
+                MESSAGE => {:type => ::Thrift::Types::STRING, :name => 'message', :optional => true}
+              }
+
+              def struct_fields; FIELDS; end
+
+              def validate
+                raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Required field errorCode is unset!') unless @errorCode
+                unless @errorCode.nil? || Evernote::EDAM::Error::EDAMErrorCode::VALID_VALUES.include?(@errorCode)
+                  raise ::Thrift::ProtocolException.new(::Thrift::ProtocolException::UNKNOWN, 'Invalid value of field errorCode!')
+                end
+              end
+
+              ::Thrift::Struct.generate_accessors self
+            end
+
+            # This exception is thrown by EDAM procedures when a caller asks to perform
+            # an operation that does not exist.  This may be thrown based on an invalid
+            # primary identifier (e.g. a bad GUID), or when the caller refers to an object
+            # by another unique identifier (e.g. a User's email address).
+            # 
+            # identifier:  the object identifier that was not found on the server.
+            # 
+            # key:  the value passed from the client in the identifier, which was not
+            #   found.  E.g. the GUID of an object that was not found.
+            class EDAMNotFoundException < ::Thrift::Exception
+              include ::Thrift::Struct, ::Thrift::Struct_Union
+              IDENTIFIER = 1
+              KEY = 2
+
+              FIELDS = {
+                IDENTIFIER => {:type => ::Thrift::Types::STRING, :name => 'identifier', :optional => true},
+                KEY => {:type => ::Thrift::Types::STRING, :name => 'key', :optional => true}
+              }
+
+              def struct_fields; FIELDS; end
+
+              def validate
+              end
+
+              ::Thrift::Struct.generate_accessors self
+            end
+
+          end
+        end
+      end