evertils-common 0.3.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b9038ca948f737bd4428305769288a85266cb578
-  data.tar.gz: 34bc8249af09505f5ce018145ff20db106e674cb
+  metadata.gz: c5c3bbd18a393a156658617c52141aac0f240d20
+  data.tar.gz: 3a2c99ccf274dd74564e4455ad99da612a5d8aeb
 SHA512:
-  metadata.gz: c34cf9d3614cb2fbed819e6b4b987d22eb4d989dfef1d35a348f2d77b8fbf6fc3ed829c362c6ed534fff72d8e01e76e8e8c320eef0e5231c450a6017ef4d6ae1
-  data.tar.gz: e1d991a75e40f0763fb541bc7421bc6fcddea49097c7eeef171c0390cadfc29ebb3476646837b3aee31e28985ee47b94fae1a0cceac1086c3af0328705e2e787
+  metadata.gz: 4dfe0cb7e60bdf8df02e1310476bb651bd70fa4209bc6dfae4ddf97d02d8b1e2c9dcf362fa5d8f1e585a31967725a1c13a63ba58a429a7624d0b33ddb7deb4ef
+  data.tar.gz: 1da86f2c6fed45d76ba2a7a241c93dcc5828aa4cc29d949708fe270fbeb6e546559708f41185d993e3ef57ccdbaa8e4b1991ce03d73f003d7672b82631118c6f

data/lib/evertils/common.rb

@@ -27,6 +27,7 @@ require 'evertils/common/entity/note'
 require 'evertils/common/entity/tag'
 require 'evertils/common/entity/tags'
 require 'evertils/common/entity/sync'
+require 'evertils/common/entity/stack'
 
 require 'evertils/common/converter/yaml_to_enml'
 

data/lib/evertils/common/authentication.rb

@@ -1,76 +1,141 @@
+require 'singleton'
+
 module Evertils
   module Common
     class Authentication
       include Singleton
 
-      attr_accessor :store, :shardId, :version
-
       def initialize
         begin
-          if Evertils.token.nil?
-            Notify.error("Evernote developer token is not configured properly!\n$EVERTILS_TOKEN == nil")
-          end
-
-          userStoreUrl = "https://#{Evertils.host}/edam/user"
-
-          userStoreTransport = Thrift::HTTPClientTransport.new(userStoreUrl)
-          userStoreProtocol = Thrift::BinaryProtocol.new(userStoreTransport)
-          @@user = ::Evernote::EDAM::UserStore::UserStore::Client.new(userStoreProtocol)
-
-          if Evertils.is_test?
-            puts "TEST USER: #{info[:user]}"
-          end
-
-          versionOK = @@user.checkVersion("evernote-data", ::Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR, ::Evernote::EDAM::UserStore::EDAM_VERSION_MINOR)
-
-          @version = "#{::Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR}.#{::Evernote::EDAM::UserStore::EDAM_VERSION_MINOR}"
-          @shardId = user.shardId
-
-          if !versionOK
-            Notify.error("Evernote API requires an update.  Latest version is #{@version}")
-          end
+          # attempt to login as the Evernote user
+          prepare_user
 
-          noteStoreUrl = @@user.getNoteStoreUrl(Evertils.token)
+          # quit with message if requirements not met
+          Notify.error("Evernote developer token is not configured properly!\n$EVERTILS_TOKEN == nil") if Evertils.token.nil?
+          Notify.error("Evernote API requires an update.  Latest version is #{@version}") if requires_update
 
-          noteStoreTransport = Thrift::HTTPClientTransport.new(noteStoreUrl)
-          noteStoreProtocol = Thrift::BinaryProtocol.new(noteStoreTransport)
-          @store = ::Evernote::EDAM::NoteStore::NoteStore::Client.new(noteStoreProtocol)
+          # prepare the main data model access point
+          prepare_note_store
         rescue Evernote::EDAM::Error::EDAMSystemException => e
-          Notify.warning("Problem authenticating, EDAM code #{e.errorCode}")
-
-          case e.errorCode
-          when 19
-            minutes = (e.rateLimitDuration/60).to_i
-            Notify.warning("You are rate limited!  Wait #{minutes} minutes")
-            exit(0)
-          end
+          handle_edam_errors(e)
         end
       end
 
       def info
         {
-          :user => "#{user.name} (#{user.username}) - ID##{user.id}",
-          :shard => user.shardId,
+          :user => "#{@user.name} (#{@user.username}) - ID##{@user.id}",
+          :shard => @user.shardId,
           :api_version => @version,
         }
       end
 
-      def user
-        @@user.getUser(Evertils.token)
+      def call(func, *args)
+        begin
+          if args.size > 0
+            @noteStore.method(func.to_s).call(Evertils.token, *args)
+          else
+            @noteStore.method(func.to_s).call(Evertils.token)
+          end
+        rescue Evernote::EDAM::Error::EDAMSystemException => e
+          Notify.warning e.inspect
+          nil
+        end
       end
 
-      def call(func, *args)
+      def call_user(func, *args)
         begin
           if args.size > 0
-            @store.method(func.to_s).call(Evertils.token, *args)
+            @userStore.method(func.to_s).call(*args)
           else
-            @store.method(func.to_s).call(Evertils.token)
+            @userStore.method(func.to_s).call
           end
         rescue Evernote::EDAM::Error::EDAMSystemException => e
           Notify.warning e.inspect
           nil
         end
       end
+
+      private
+
+      def prepare_user
+        userStoreUrl = "https://#{Evertils.host}/edam/user"
+
+        userStoreTransport = Thrift::HTTPClientTransport.new(userStoreUrl)
+        userStoreProtocol = Thrift::BinaryProtocol.new(userStoreTransport)
+        @userStore = ::Evernote::EDAM::UserStore::UserStore::Client.new(userStoreProtocol)
+        @user = call_user(:getUser, Evertils.token)
+
+        if Evertils.is_test?
+          Notify.spit "TEST USER: #{info[:user]}"
+        end
+      end
+
+      def prepare_note_store
+        noteStoreUrl = call_user(:getNoteStoreUrl, Evertils.token)
+
+        noteStoreTransport = Thrift::HTTPClientTransport.new(noteStoreUrl)
+        noteStoreProtocol = Thrift::BinaryProtocol.new(noteStoreTransport)
+        @noteStore = ::Evernote::EDAM::NoteStore::NoteStore::Client.new(noteStoreProtocol)
+      end
+
+      def requires_update
+        #entity = @userStore.checkVersion("evernote-data", ::Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR, ::Evernote::EDAM::UserStore::EDAM_VERSION_MINOR)
+        entity = call_user(:checkVersion, "evernote-data", ::Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR, ::Evernote::EDAM::UserStore::EDAM_VERSION_MINOR)
+
+        @version = "#{::Evernote::EDAM::UserStore::EDAM_VERSION_MAJOR}.#{::Evernote::EDAM::UserStore::EDAM_VERSION_MINOR}"
+
+        !entity
+      end
+
+      def handle_edam_errors(e)
+        Notify.warning("Problem authenticating, EDAM code #{e.errorCode}")
+
+        case e.errorCode
+        when 1
+          message = 'An unknown error occurred'
+        when 2
+          message = 'The format of the request data was incorrect'
+        when 3
+          message = 'Not permitted to perform action'
+        when 4
+          message = 'Unexpected problem with the service'
+        when 5
+          message = 'A required parameter/field was absent'
+        when 6
+          message = 'Operation denied due to data model limit'
+        when 7
+          message = 'Operation denied due to user storage limit'
+        when 8
+          message = 'Username and/or password incorrect'
+        when 9
+          message = 'Authentication token expired'
+        when 10
+          message = 'Change denied due to data model conflict'
+        when 11
+          message = 'Content of submitted note was malformed'
+        when 12
+          message = 'Service shard with account data is temporarily down'
+        when 13
+          message = 'Operation denied due to data model limit, where something such as a string length was too short'
+        when 14
+          message = 'Operation denied due to data model limit, where something such as a string length was too long'
+        when 15
+          message = 'Operation denied due to data model limit, where there were too few of something'
+        when 16
+          message = 'Operation denied due to data model limit, where there were too many of something'
+        when 17
+          message = 'Operation denied because it is currently unsupported'
+        when 18
+          message = 'Operation denied because access to the corresponding object is prohibited in response to a take-down notice'
+        when 19
+          minutes = (e.rateLimitDuration/60).to_i
+          message = "You are rate limited!  Wait #{minutes} minutes"
+        end
+        
+        Notify.warning(message)
+        exit(0)
+      end
+
     end
   end
 end

data/lib/evertils/common/converter.rb

@@ -5,8 +5,10 @@ module Evertils
         
         #
         # @since 0.2.8
-        def deprecation_notice(version)
-          puts "Deprecated as of #{version}"
+        def deprecation_notice(version, message)
+          output = "Deprecated as of #{version}"
+          output += "\nReason: #{message}" if message
+          output
         end
 
       end

data/lib/evertils/common/entity.rb

@@ -3,7 +3,7 @@ module Evertils
     module Entity
       class Base
 
-        attr_accessor :evernote
+        attr_accessor :evernote, :entity
 
         def initialize
           @evernote = Authentication.instance
@@ -19,8 +19,10 @@ module Evertils
 
         #
         # @since 0.2.8
-        def deprecation_notice(version)
-          puts "Deprecated as of #{version}"
+        def deprecation_notice(version, message)
+          output = "Deprecated as of #{version}"
+          output += "\nReason: #{message}" if message
+          output
         end
 
         #

data/lib/evertils/common/entity/note.rb

@@ -116,7 +116,7 @@ module Evertils
         #
         # @since 0.2.0
         def expunge
-          deprecation_notice('0.2.9')
+          deprecation_notice('0.2.9', 'Replaced with expunge! to better follow Ruby standards for method names.  Will be removed in 0.3.5')
 
           @evernote.call(:expungeNote, @entity.guid)
         end
@@ -127,7 +127,7 @@ module Evertils
           nb = Evertils::Common::Manager::Notebook.new
           target = nb.find(notebook)
 
-          raise "Notebook not found: #{notebook}" if !target
+          raise "Notebook not found: #{notebook}" if target.entity.nil?
           
           @entity.notebookGuid = target.prop(:guid)
 
@@ -152,16 +152,14 @@ module Evertils
           @entity = nil
 
           filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
-          filter.words = name
+          filter.words = "intitle:#{name}"
 
           spec = ::Evernote::EDAM::NoteStore::NotesMetadataResultSpec.new
           spec.includeTitle = true
 
           result = @evernote.call(:findNotesMetadata, filter, 0, 1, spec)
 
-          if result.totalNotes > 0
-            @entity = result.notes[0]
-          end
+          @entity = result.notes.detect { |note| note.title == name }
 
           self if @entity
         end
@@ -174,12 +172,6 @@ module Evertils
           @evernote.call(:updateNote, @entity)
         end
 
-        #
-        # @since 0.3.0
-        def entity
-          @entity
-        end
-
       end
     end
   end

data/lib/evertils/common/entity/notebook.rb

@@ -67,16 +67,10 @@ module Evertils
           filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
           filter.notebookGuid = @entity.guid
 
-          notes = Notes.new(@evernote)
+          notes = Notes.new
           notes.find(nil, @entity.guid)
         end
 
-        #
-        # @since 0.3.0
-        def entity
-          @entity
-        end
-
       end
     end
   end

data/lib/evertils/common/entity/notebooks.rb

@@ -29,6 +29,8 @@ module Evertils
             end
           rescue ArgumentError => e
             puts e.message
+          rescue Evernote::EDAM::Error::EDAMUserException => e
+            puts e.message
           end
         end
 

data/lib/evertils/common/entity/notes.rb

@@ -14,6 +14,7 @@ module Evertils
           response = @evernote.call(:findNotesMetadata, filter, nil, 300, spec)
           response.notes
         end
+        alias_method :find, :find_all
 
         def find_one(title, notebook = nil)
           filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
@@ -51,15 +52,14 @@ module Evertils
           spec.includeCreated = true
 
           pool = @evernote.call(:findNotesMetadata, filter, 0, 300, spec)
-          notes_by_date = []
 
-          pool.notes.each do |note|
-            note_datetime = note_date(note, period)
+          notes_by_date = pool.notes.select do |note|
+            f = finish.to_time.to_i
+            s = start.to_time.to_i
+            n = note_date(note, period).to_time.to_i
 
-            notes_by_date << note if note_datetime.strftime('%m-%d-%Y') < finish.strftime('%m-%d-%Y') && note_datetime.strftime('%m-%d-%Y') > start.strftime('%m-%d-%Y')
+            n <= f && n >= s
           end
-
-          notes_by_date
         end
 
         #
@@ -75,15 +75,13 @@ module Evertils
           spec.includeCreated = true
 
           pool = @evernote.call(:findNotesMetadata, filter, 0, 300, spec)
-          notes_by_date = []
           
-          pool.notes.each do |note|
-            note_datetime = note_date(note, period)
+          notes_by_date = pool.notes.select do |note|
+            d = date.to_time.to_i
+            n = note_date(note, period).to_time.to_i
 
-            notes_by_date << note if note_datetime.strftime('%m-%d-%Y') == date.strftime('%m-%d-%Y')
+            n == d
           end
-
-          notes_by_date
         end
 
         private

data/lib/evertils/common/manager.rb

@@ -25,8 +25,10 @@ module Evertils
 
         #
         # @since 0.3.0
-        def deprecation_notice(version)
-          puts "Deprecated as of #{version}"
+        def deprecation_notice(version, message)
+          output = "Deprecated as of #{version}"
+          output += "\nReason: #{message}" if message
+          output
         end
 
       end

data/lib/evertils/common/manager/note.rb

@@ -8,6 +8,7 @@ module Evertils
         def create(config)
           entity = Evertils::Common::Entity::Note.new
           entity.create(config[:name], config[:body], config[:notebook], config[:files], config[:shared], config[:created_on])
+          entity
         end
 
         #
@@ -15,6 +16,21 @@ module Evertils
         def find(name)
           entity = Evertils::Common::Entity::Note.new
           entity.find(name)
+          entity
+        end
+
+        #
+        # @since 0.3.1
+        def find_or_create(name, stack = nil)
+          search_result = find(name)
+
+          if !search_result
+            note = create(name, stack)
+          else
+            note = search_result
+          end
+
+          note
         end
 
       end

data/lib/evertils/common/manager/notebook.rb

@@ -8,6 +8,7 @@ module Evertils
         def create(name, stack = nil)
           entity = Evertils::Common::Entity::Notebook.new
           entity.create(name, stack)
+          entity
         end
 
         #
@@ -15,6 +16,7 @@ module Evertils
         def find(name)
           entity = Evertils::Common::Entity::Notebook.new
           entity.find(name)
+          entity
         end
 
         #

data/lib/evertils/common/manager/tag.rb

@@ -8,6 +8,7 @@ module Evertils
         def create(name)
           entity = Evertils::Common::Entity::Tag.new
           entity.create(name)
+          entity
         end
 
         #
@@ -15,6 +16,21 @@ module Evertils
         def find(name)
           entity = Evertils::Common::Entity::Tag.new
           entity.find(name)
+          entity
+        end
+
+        #
+        # @since 0.3.1
+        def find_or_create(name, stack = nil)
+          search_result = find(name)
+
+          if !search_result
+            note = create(name, stack)
+          else
+            note = search_result
+          end
+
+          note
         end
 
       end

data/lib/evertils/common/query.rb

@@ -5,8 +5,10 @@ module Evertils
 
         #
         # @since 0.2.8
-        def deprecation_notice(version)
-          puts "Deprecated as of #{version}"
+        def deprecation_notice(version, message)
+          output = "Deprecated as of #{version}"
+          output += "\nReason: #{message}" if message
+          output
         end
 
         #

data/lib/evertils/common/query/simple.rb

@@ -15,18 +15,10 @@ module Evertils
           Entity::Tags.new.all
         end
 
-        #
-        # @since 0.2.0
-        def notebook_by_name(name)
-          entity = Entity::Notebook.new
-          nb = entity.find(name)
-          nb.entity
-        end
-
         #
         # @since 0.2.0
         def notes_by_notebook(name)
-          entity = Entity::Notebook.new
+          entity = Manager::Notebook.new
           nb = entity.find(name)
           nb.notes
         end
@@ -43,7 +35,6 @@ module Evertils
         def create_note_from(full_path)
           entity = Entity::Note.new
           note = entity.create_from_yml(full_path)
-          note.entity
         end
 
         #
@@ -51,7 +42,6 @@ module Evertils
         def create_notebooks_from(full_path)
           entity = Entity::Notebooks.new
           nb = entity.create_from_yml(full_path)
-          nb.entity
         end
 
         #
@@ -59,37 +49,59 @@ module Evertils
         def create_notebook(name, stack = nil)
           entity = Entity::Notebook.new
           nb = entity.create(name, stack)
-          nb.entity
+        end
+
+        #
+        # @since 0.3.1
+        def create_tag(name)
+          entity = Manager::Tag.new
+          tag = entity.create(name)
+        end
+
+        #
+        # @since 0.2.0
+        def create_note(title, body, p_notebook_name = nil, file = nil, share_note = false, created_on = nil)
+          entity = Manager::Note.new
+          conf = { name: title, body: body, notebook: p_notebook_name, files: file, shared: share_note, created_on: created_on }
+          note = entity.create(conf)
         end
 
         #
         # @since 0.2.0
         def find_note(title_filter = nil, notebook_filter = nil)
-          entity = Entity::Note.new
+          entity = Manager::Note.new
           note = entity.find(title_filter, notebook_filter)
-          note.entity
+        end
+
+        #
+        # @since 0.3.1
+        def find_notebook(name)
+          entity = Manager::Notebook.new
+          nb = entity.find(name)
         end
 
         #
         # @since 0.2.0
-        def note_exists(name)
-          entity = Entity::Note.new
-          note = entity.find(name)
-          note.exists?
+        # @deprecated 0.3.1
+        def notebook_by_name(name)
+          deprecation_notice('0.3.1', 'Replaced by #find_notebook method.  Will be removed in 0.4.0')
+
+          entity = Manager::Notebook.new
+          nb = entity.find(name)
         end
 
         #
         # @since 0.2.0
-        def create_note(title, body, p_notebook_name = nil, file = nil, share_note = false, created_on = nil)
-          entity = Entity::Note.new
-          note = nm.create(title, body, p_notebook_name, file, share_note, created_on)
-          note.entity
+        def note_exists(name)
+          entity = Manager::Note.new
+          note = entity.find(name)
+          note.exists?
         end
 
         #
         # @since 0.2.0
         def destroy_note(name)
-          entity = Entity::Note.new
+          entity = Manager::Note.new
           note = entity.find(name)
           note.expunge!
         end

data/lib/evertils/common/version.rb

@@ -1,7 +1,7 @@
 module Evertils
   module Common
 
-    VERSION = "0.3.0"
+    VERSION = "0.3.1"
 
   end
 end

data/lib/evertils/test/base.rb

@@ -76,39 +76,27 @@ module Evertils
       # Remove all seeded data after all tests have run
       # @since 0.3.0
       def clean
-        full_path = File.join(File.dirname(__FILE__), 'seed/all.yml')
-        
-        begin
-          if File.exist? full_path
-            conf = YAML::load(File.open(full_path))
-            
-            nb = Evertils::Common::Entity::Notebooks.new
-            nbm = Evertils::Common::Manager::Notebook.new
-            auth = Evertils::Common::Authentication.instance
-            tm = Evertils::Common::Entity::Tags.new
-
-            puts "Deleting all tags..."
-            tags = tm.all
-            tags.each do |tag|
-              auth.call(:expungeTag, tag.guid)
-            end
-
-            puts "Deleting all notebooks..."
-            notebooks = nb.all
-            default = nbm.find_or_create('Default')
+        nb = Evertils::Common::Entity::Notebooks.new
+        nbm = Evertils::Common::Manager::Notebook.new
+        auth = Evertils::Common::Authentication.instance
+        tm = Evertils::Common::Entity::Tags.new
+
+        puts "Deleting all tags..."
+        tags = tm.all
+        tags.each do |tag|
+          auth.call(:expungeTag, tag.guid)
+        end
 
-            notebooks.each do |nb|
-              next if nb.guid == default.prop(:guid)
-              auth.call(:expungeNotebook, nb.guid)
-            end
+        puts "Deleting all notebooks..."
+        notebooks = nb.all
+        default = nbm.find_or_create('Default')
 
-            puts "Sample data deleted"
-          else
-            raise ArgumentError, "File not found: #{full_path}"
-          end
-        rescue ArgumentError => e
-          puts e.message
+        notebooks.each do |nb|
+          next if nb.guid == default.prop(:guid)
+          auth.call(:expungeNotebook, nb.guid)
         end
+
+        puts "Sample data deleted"
       end
 
     end

data/lib/evertils/test/seed/note.yml

@@ -0,0 +1,3 @@
+title: Derping
+body: This is the body
+parent: nil

data/lib/evertils/test/seed/notebooks.yml

@@ -0,0 +1,4 @@
+notebooks:
+  - test
+  - test2
+  - test3

data/lib/evertils/test/seed/stack.yml

@@ -0,0 +1,7 @@
+name: HF2
+children:
+  - Accounts
+  - Agendas
+  - Design Documents
+  - Interviews/HR
+  - Notes + Documentation

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evertils-common
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Ryan Priebe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-12-30 00:00:00.000000000 Z
+date: 2016-01-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -125,6 +125,9 @@ files:
 - lib/evertils/test.rb
 - lib/evertils/test/base.rb
 - lib/evertils/test/seed/all.yml
+- lib/evertils/test/seed/note.yml
+- lib/evertils/test/seed/notebooks.yml
+- lib/evertils/test/seed/stack.yml
 homepage: http://rubygems.org/gems/evertils-common
 licenses:
 - MIT