evernote_utils 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d685d866c342871313bfa2097b429070eb85cf19
+  data.tar.gz: b9409c88a0a1be45349cf917325748accd29b3bf
+SHA512:
+  metadata.gz: d31b657e16fb0d7813c8b6bca8ec57409d45959280d94de99f0db7620157fe108d320fca00873352d8b77bfff08804239f059393b53e48ba530b187b6c1c3b00
+  data.tar.gz: 864fcfe1cedf797ac4cc7ba59e669aa42f5978dac084cdc4101918f83a119c388472e55ac8a7517d3349945a0933e0b4d3d87014bcc47533a5805f08931cd0ac

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 memerelics
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,92 @@
+# EvernoteUtils
+
+A thin OOP-friendly wrapper of Evernote Ruby SDK.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'evernote_utils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install evernote_utils
+
+
+## Requirement
+
+If you don't have your Evernote API Key yet, get it from [Evernote Developers Page](http://dev.evernote.com/doc/).
+
+Note that you should send "Activation Request" to access productionn data. Please check [Frequently Ask Questions - Evernote Developers](http://dev.evernote.com/support/faq.php#activatekey).
+
+Then authenticate user's Evernote account via OAuth. Instruction is here: [Getting Started with the Evernote API - Evernote Developers](http://dev.evernote.com/doc/start/ruby.php)
+
+
+EvenoteUtils don't support authentication feature, because dominant other options are available. For instance:
+
+* [evernote_oauth](https://github.com/fourfour/evernote_oauth)
+* [omniauth-evernote](https://github.com/szimek/omniauth-evernote)
+
+
+## Usage
+
+First, initialize ENUtils with an OAuth token credential identifier.
+
+    enutils = ENUtils::Core.new('oauth-token-credential-identifier')
+
+    # If you use sandbox token, pass 2nd argument false.
+    enutils = ENUtils::Core.new('oauth-token-credential-identifier', false)
+
+OAuth token credential identifier looks something like:
+
+    S=s4:U=a1:E=12bfd68c6b6:C=12bf8426ab8:P=7:A=en_oauth_test:H=3df9cf6c0d7bc410824c80231e64dbe1
+
+Then you can access Evernote resources.
+
+    enutils.notes(words: 'Clojure', limit: 5, order: :updated)
+
+It returns `ENUtils::Note` instances. `ENUtils::Note` is a thin wrapper of `Evernote::EDAM::Type::Tag`.
+
+And here, `ENUtils#notes` accepts following options:
+
+* notebook
+* tag, tags
+* words (fulltext search api)
+* order (`:created, :updated, :relevance, :update_sequence_number, :title`)
+* asc (true/false)
+* offset (default is 0)
+* limit (default is 10)
+
+`ENUtils#notebooks` and `ENUtils#tags` accept name filtering. You can use String or Regexp.
+
+    enutils.notebooks(name: 'Twitter')
+    enutils.tags(name: /ruby/i)
+
+These methods return array of `ENUtils::Notebook` and `ENUtils::Tag` respectively, which available to filter notes.
+
+    notebook = enutils.notebooks(name: /Book/).first
+    tag      = enutils.tags(name: 'language').first
+    enutils.notes(notebook: notebook, tag: tag)
+
+    # or, you can use multiple tags
+    enutils.notes(notebook: notebook, tags: [tagA, tagB, tagC])
+
+
+## Planning to do
+
+* relationships: notebook.notes, note.tags, tag.notes
+* counting result notes
+
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require "bundler/gem_tasks"
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs.push 'spec'
+  t.pattern = 'spec/**/*_spec.rb'
+  t.verbose = true
+end

data/evernote_utils.gemspec

@@ -0,0 +1,29 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'evernote_utils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "evernote_utils"
+  spec.version       = ENUtils::VERSION
+  spec.authors       = ["memerelics"]
+  spec.email         = ["takuya21hashimoto@gmail.com"]
+  spec.description   = %q{simple wrapper for evernote api}
+  spec.summary       = %q{simple wrapper for evernote api}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'evernote-thrift', '~>1.25.1'
+  spec.add_dependency 'activesupport', '~>4.0.2'
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "pry"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "mocha"
+end

data/lib/evernote_utils.rb

@@ -0,0 +1,47 @@
+require "evernote_utils/version"
+
+require 'evernote-thrift'
+require "evernote_utils/note"
+require "evernote_utils/notebook"
+require "evernote_utils/tag"
+
+module ENUtils
+  class InvalidVersion < StandardError; end
+
+  class Core
+    attr_accessor :token, :notestore
+
+    def initialize(token, production=true)
+
+      userStoreUrl = "https://#{production ? 'www' : 'sandbox'}.evernote.com/edam/user"
+      userStoreTransport = Thrift::HTTPClientTransport.new(userStoreUrl)
+      userStoreProtocol = Thrift::BinaryProtocol.new(userStoreTransport)
+      userStore = Evernote::EDAM::UserStore::UserStore::Client.new(userStoreProtocol)
+
+      versionOK = userStore.checkVersion("Evernote EDAMTest (Ruby)",
+                                         Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR,
+                                         Evernote::EDAM::UserStore::EDAM_VERSION_MINOR)
+      raise InvalidVersion unless versionOK
+
+      noteStoreUrl = userStore.getNoteStoreUrl(token)
+
+      noteStoreTransport = Thrift::HTTPClientTransport.new(noteStoreUrl)
+      noteStoreProtocol = Thrift::BinaryProtocol.new(noteStoreTransport)
+      @notestore = Evernote::EDAM::NoteStore::NoteStore::Client.new(noteStoreProtocol)
+
+      @token = token
+    end
+
+    def notes(options={})
+      Note.where(self, options)
+    end
+
+    def notebooks(options={})
+      Notebook.where(self, options)
+    end
+
+    def tags(options={})
+      Tag.where(self, options)
+    end
+  end
+end

data/lib/evernote_utils/note.rb

@@ -0,0 +1,71 @@
+require 'active_support/core_ext/object'
+
+module ENUtils
+  class Note < Evernote::EDAM::Type::Note
+
+    DEFAULT_LIMIT = 10
+
+    # Evernote::EDAM::Type::Note fields
+    #   guid:"f1df2a4d-5852-4cb6-82f7-6240ee4e2b5c"
+    #   title:"Note title"
+    #   contentHash:eeeeeeee6bxxxxxxxxxxxxxxxa889ca7
+    #   contentLength:2246
+    #   created:1266881336000
+    #   updated:1266881347000
+    #   active:true
+    #   updateSequenceNum:2653
+    #   notebookGuid:"4xxxxxda-xxxx-xxxx-xxxx-zzzzzzzzzzzz"
+    #   attributes:<Evernote::EDAM::Type::NoteAttributes >
+
+    attr_reader :guid, :title, :contentHash, :contentLength, :created, :updated, :active, :updateSequenceNum, :notebookGuid, :attributes
+
+    # created: 1, updated: 2, relevance: 3, update_sequence_number: 4, title: 5
+    OrderFields = Evernote::EDAM::Type::NoteSortOrder::VALUE_MAP.reduce({}){|accum, pair|
+      accum.merge(pair.last.downcase.to_sym => pair.first)
+    }
+
+    def initialize(edam_note)
+       @guid              = edam_note.guid
+       @title             = edam_note.title
+       @contentHash       = edam_note.contentHash
+       @contentLength     = edam_note.contentLength
+       @created           = Time.at(edam_note.created/1000)
+       @updated           = Time.at(edam_note.updated/1000)
+       @active            = edam_note.active
+       @updateSequenceNum = edam_note.updateSequenceNum
+       @notebookGuid      = edam_note.notebookGuid
+       @attributes        = edam_note.attributes
+    end
+
+    def self.where(core, options={})
+      offset = options.delete(:offset) || 0
+      limit  = options.delete(:limit)  || DEFAULT_LIMIT
+      core.notestore.findNotes(core.token, build_filter(options), offset, limit)
+        .notes.map{|n| new(n) }
+    end
+
+    private
+
+    def self.build_filter(options={})
+      filter = Evernote::EDAM::NoteStore::NoteFilter.new
+      if (notebook = options[:notebook])
+        notebook_guid = notebook.is_a?(ENUtils::Notebook) ? notebook.guid : notebook
+        filter.notebookGuid = notebook_guid
+      end
+      if (tags = options[:tags]) || (tag = options[:tag])
+        tag_guids = (tags || [tag]).map{|t| t.is_a?(ENUtils::Tag) ? t.guid : t }
+        filter.tagGuids = tag_guids
+      end
+      filter.words     = options[:words] if options[:words]
+      filter.order     = OrderFields[options[:order].to_sym] if available_order?(options[:order])
+      filter.ascending = options[:asc] if options[:asc]
+      filter
+    end
+
+    def self.available_order?(value)
+      return false if value.nil?
+      OrderFields.keys.include?(value.to_sym)
+    end
+
+  end
+end

data/lib/evernote_utils/notebook.rb

@@ -0,0 +1,39 @@
+module ENUtils
+  class Notebook < Evernote::EDAM::Type::Notebook
+
+     # Evernote::EDAM::Type::Notebook fields
+     #   guid:"afa4ba59-xxxx-42ed-xxxx-zzzzzzzzzzzz"
+     #   name:"Books"
+     #   updateSequenceNum:24108
+     #   defaultNotebook:false
+     #   serviceCreated:1297607548000
+     #   serviceUpdated:1387262389000
+     #   restrictions:<Evernote::EDAM::Type::NotebookRestrictions ...>
+
+      attr_reader :guid, :name, :updateSequenceNum, :defaultNotebook, :serviceCreated, :serviceUpdated, :restrictions
+
+    def initialize(edam_notebook)
+      @guid              = edam_notebook.guid
+      @name              = edam_notebook.name
+      @updateSequenceNum = edam_notebook.updateSequenceNum
+      @defaultNotebook   = edam_notebook.defaultNotebook
+      @serviceCreated    = Time.at(edam_notebook.serviceCreated/1000)
+      @serviceUpdated    = Time.at(edam_notebook.serviceUpdated/1000)
+      @restrictions      = edam_notebook.restrictions
+    end
+
+    def self.where(core, options={})
+      notebooks = core.notestore.listNotebooks(core.token).map{|nb| new(nb) }
+      return notebooks if options.empty?
+      case options[:name]
+      when String
+        notebooks.select{|nb| options[:name] == nb.name }
+      when Regexp
+        notebooks.select{|nb| options[:name] =~ nb.name }
+      else
+        notebooks
+      end
+    end
+
+  end
+end

data/lib/evernote_utils/tag.rb

@@ -0,0 +1,30 @@
+module ENUtils
+  class Tag < Evernote::EDAM::Type::Tag
+
+     # Evernote::EDAM::Type::Tag fields
+     #   guid:"xxxxxxxx-xxxx-xxxx-xxxx-zzzzzzzzzzzz",
+     #   name:"MyTag",
+     #   updateSequenceNum:4378
+    attr_reader :guid, :name, :updateSequenceNum
+
+    def initialize(edam_tag)
+      @guid              = edam_tag.guid
+      @name              = edam_tag.name
+      @updateSequenceNum = edam_tag.updateSequenceNum
+    end
+
+    def self.where(core, options={})
+      tags = core.notestore.listTags(core.token).map{|t| new(t) }
+      return tags if options.empty?
+      case options[:name]
+      when String
+        tags.select{|t| options[:name] == t.name }
+      when Regexp
+        tags.select{|t| options[:name] =~ t.name }
+      else
+        tags
+      end
+    end
+
+  end
+end

data/lib/evernote_utils/version.rb

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

data/spec/evernote_utils_spec.rb

@@ -0,0 +1,16 @@
+require 'spec_helper'
+
+describe EvernoteUtils::Core do
+  before do
+    Thrift::HTTPClientTransport.stubs(new: nil)
+    Thrift::BinaryProtocol.stubs(new: nil)
+
+    us = mock('Evernote::EDAM::UserStore::UserStore::Client')
+    Evernote::EDAM::UserStore::UserStore::Client.stubs(new: us)
+    us.stubs(checkVersion: true,
+             getNoteStoreUrl: 'http://note_store_url/')
+  end
+  it {
+    EvernoteUtils::Core.new('dummy_token').must_be_instance_of EvernoteUtils::Core
+  }
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'minitest/spec'
+require 'minitest/autorun'
+require 'mocha/setup'
+
+require 'evernote_utils'

metadata

@@ -0,0 +1,157 @@
+--- !ruby/object:Gem::Specification
+name: evernote_utils
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- memerelics
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: evernote-thrift
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.25.1
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.0.2
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: mocha
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: simple wrapper for evernote api
+email:
+- takuya21hashimoto@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- evernote_utils.gemspec
+- lib/evernote_utils.rb
+- lib/evernote_utils/note.rb
+- lib/evernote_utils/notebook.rb
+- lib/evernote_utils/tag.rb
+- lib/evernote_utils/version.rb
+- spec/evernote_utils_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: simple wrapper for evernote api
+test_files:
+- spec/evernote_utils_spec.rb
+- spec/spec_helper.rb