evertils-common 0.2.8.2 → 0.2.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 96121746b417fad17240462ed1a4a4f0341c91b7
-  data.tar.gz: 960e7deaa5084e9f2011ae7b92f34fdfcfcbc187
+  metadata.gz: 33ead3b9f1561bc3a2b5de59335fc9e7251c210b
+  data.tar.gz: 29a60ff3a7ed7446b9d5b92ec968144fe9d302fe
 SHA512:
-  metadata.gz: 6c84832f8afcacfcdf834ac59953a2f8ae0138623ac3e1fb53029373b22f2d2b408559a16cd84e407f55ff2a81ac45199ffe832ea4e9da3a1acb8c6762ecee07
-  data.tar.gz: 1e9cba8d9cba304c7902e9187782b8ae073df02bb1fcf33aedb2971a586572ac1deeb0ecd7ba69ff96568364428b5813c198b0726798628b250ac127dbc48409
+  metadata.gz: 0102d8cb3bc70c7d1ad2864451f0db431eab0f9d9b0e70ae12cf0a8a31879694b35f973bebd91148280773f94f2b1209cc3ce317b61a0062f9ecf8234f89bc05
+  data.tar.gz: cc23fd26183b67cbfdd00170b5726322eb6a104c30ffc6e1b649926be250b742c4d52c1f70b331c3d0d1e28b767c2563c963405335d66ef5adba14bacb03bfdb

data/README.md

@@ -1,5 +1,7 @@
 # Evertils::Common
 
+[![Code Climate](https://codeclimate.com/github/aapis/evertils-common/badges/gpa.svg)](https://codeclimate.com/github/aapis/evertils-common)
+
 Evertils::Common is an abstraction library for interacting with the Evernote API.
 
 ## Installation

data/lib/evertils/common/converter/yaml_to_enml.rb

@@ -3,6 +3,48 @@ module Evertils
     module Converter
       class YamlToEnml < Converter::Base
         
+        #
+        # @since 0.2.9
+        def from_file(path)
+          contents = File.open(path, "rb") { |io| io.read }
+          obj = YAML::load(contents)
+
+          builder(obj)
+        end
+
+        #
+        # @since 0.2.9
+        def from_string(yaml)
+          obj = YAML::load(yaml)
+
+          builder(obj)
+        end
+
+        private
+
+        #
+        # @since 0.2.9
+        def builder(obj)
+          # hardcoding XML here because it's quick/easy
+          enml = '<?xml version="1.0" encoding="UTF-8"?>'
+          enml += '<!DOCTYPE "en-note" SYSTEM "http://xml.evernote.com/pub/enml2.dtd">'
+          enml += '<en-note>'
+            obj.each do |k, v|
+              if v.is_a? Array
+                enml += "<p>#{k}</p>"
+                enml += "<ul>"
+                  v.each do |child|
+                    enml += "<li>#{child}</li>"
+                  end
+                enml += "</ul>"
+              else
+                enml += "<p>#{k}: #{v}</p>"
+              end
+            end
+          enml += '</en-note>'
+          enml
+        end
+
       end
     end
   end

data/lib/evertils/common/converter.rb

@@ -9,12 +9,6 @@ module Evertils
           puts "Deprecated as of #{version}"
         end
 
-        #
-        # @since 0.2.8
-        def deprecation_notice(version)
-          puts "Deprecated as of #{version}"
-        end
-
       end
     end
   end

data/lib/evertils/common/enml.rb

@@ -16,19 +16,17 @@ module Evertils
       private
       
       def enml_element
-        if @file
-          read_file = File.open(@file, 'rb') { |io| io.read }
+        read_file = File.open(@file, 'rb') { |io| io.read }
 
-          el = ::Evernote::EDAM::Type::Resource.new()
-          el.mime = MIME::Types.type_for(@file)[0].content_type
-          el.data = ::Evernote::EDAM::Type::Data.new()
-          el.data.size = read_file.size
-          el.data.bodyHash = Digest::MD5.hexdigest(read_file)
-          el.data.body = read_file
-          el.attributes = ::Evernote::EDAM::Type::ResourceAttributes.new()
-          el.attributes.fileName = @file # temporary for now, the actual file name
-          el
-        end
+        el = ::Evernote::EDAM::Type::Resource.new()
+        el.mime = MIME::Types.type_for(@file)[0].content_type
+        el.data = ::Evernote::EDAM::Type::Data.new()
+        el.data.size = read_file.size
+        el.data.bodyHash = Digest::MD5.hexdigest(read_file)
+        el.data.body = read_file
+        el.attributes = ::Evernote::EDAM::Type::ResourceAttributes.new()
+        el.attributes.fileName = @file # temporary for now, the actual file name
+        el
       end
     end
   end

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

@@ -3,9 +3,11 @@ module Evertils
     module Entity
       class Note < Entity::Base
 
+        #
+        # @since 0.2.0
         def create_from_yml(full_path)
           begin
-            if File.exists? full_path
+            if File.exist? full_path
               conf = YAML::load(File.open(full_path))
               required = %w(title body)
 
@@ -22,7 +24,11 @@ module Evertils
           end
         end
 
+        #
+        # @since 0.2.0
         def create(title, body, p_notebook_name = nil, file = nil, share_note = false, created_on = nil)
+          @entity = nil
+
           # final output
           output = {}
 
@@ -61,71 +67,86 @@ module Evertils
           if !p_notebook_name.is_a? ::Evernote::EDAM::Type::Notebook
             nb = Entity::Notebook.new
             parent_notebook = nb.find(p_notebook_name)
-            parent_notebook = @evernote.call(:getDefaultNotebook) if parent_notebook.nil?
+            parent_notebook = nb.default if parent_notebook.nil?
           end
           
           # parent_notebook is optional; if omitted, default notebook is used
-          our_note.notebookGuid = parent_notebook.guid
+          our_note.notebookGuid = parent_notebook.prop(:guid)
 
           # Attempt to create note in Evernote account
           begin
-            output[:note] = @evernote.call(:createNote, our_note)
-            
-            if share_note
-              shareKey = @evernote.call(:shareNote, output[:note].guid)
-              output[:share_url] = "https://#{Evertils::Common::EVERNOTE_HOST}/shard/#{@model.shardId}/sh/#{output[:note].guid}/#{shareKey}"
-            end
+            @entity = @evernote.call(:createNote, our_note)
+            share if share_note
           rescue ::Evernote::EDAM::Error::EDAMUserException => edue
             ## Something was wrong with the note data
             ## See EDAMErrorCode enumeration for error code explanation
             ## http://dev.evernote.com/documentation/reference/Errors.html#Enum_EDAMErrorCode
             Notify.error "EDAMUserException: #{edue}\nCode #{edue.errorCode}: #{edue.parameter}"
-          rescue ::Evernote::EDAM::Error::EDAMNotFoundException => ednfe
+          rescue ::Evernote::EDAM::Error::EDAMNotFoundException
             ## Parent Notebook GUID doesn't correspond to an actual notebook
             Notify.error "EDAMNotFoundException: Invalid parent notebook GUID"
           end
 
-          Notify.success("#{parent_notebook.stack}/#{parent_notebook.name}/#{our_note.title} created")
+          Notify.success("#{parent_notebook.prop(:stack)}/#{parent_notebook.prop(:name)}/#{our_note.title} created")
 
-          output
+          self if @entity
         end
 
+        #
+        # @since 0.2.0
         def exists?(name)
-          # notes = Notes.new
-          # notes.find_all(name).size > 0
           return true if !find(name).nil?
           false
         end
 
-        def destroy(name)
-          note = find(name).guid
+        #
+        # @since 0.2.0
+        def destroy
+          @evernote.call(:deleteNote, @entity.guid)
+        end
 
-          @evernote.call(:deleteNote, note)
+        #
+        # @since 0.2.9
+        def expunge!
+          @evernote.call(:expungeNote, @entity.guid)
         end
 
-        def expunge(name)
-          note = find(name).guid
+        #
+        # @since 0.2.0
+        def expunge
+          deprecation_notice('0.2.9')
 
-          @evernote.call(:expungeNote, note)
+          @evernote.call(:expungeNote, @entity.guid)
         end
 
         #
-        # @since 0.2.8
-        def share(name)
-          note = find(name).guid
+        # @since 0.2.9
+        def move_to(notebook)
+          nb = Evertils::Common::Entity::Notebook.new
+          target = nb.find(notebook)
+          
+          @entity.notebookGuid = target.prop(:guid)
 
-          @evernote.call(:shareNote, note)
+          @evernote.call(:updateNote, @entity)
         end
 
         #
         # @since 0.2.8
-        def unshare(name)
-          note = find(name).guid
+        def share
+          @evernote.call(:shareNote, @entity.guid)
+        end
 
-          @evernote.call(:stopSharingNote, note)
+        #
+        # @since 0.2.8
+        def unshare
+          @evernote.call(:stopSharingNote, @entity.guid)
         end
 
+        #
+        # @since 0.2.0
         def find(name)
+          @entity = nil
+
           filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
           filter.words = name
 
@@ -135,65 +156,12 @@ module Evertils
           result = @evernote.call(:findNotesMetadata, filter, 0, 1, spec)
 
           if result.totalNotes > 0
-            return result.notes[0]
+            @entity = result.notes[0]
           end
-        end
-        alias_method :find_by_name, :find
-        
-        def find_by_date_range(start, finish = DateTime.now, period = :created)
-          filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
-          filter.words = "#{period}:year-#{year_diff(start.year)}"
-          filter.order = 1
-
-          spec = ::Evernote::EDAM::NoteStore::NotesMetadataResultSpec.new
-          spec.includeTitle = true
-          spec.includeUpdated = true
-          spec.includeCreated = true
 
-          pool = @evernote.call(:findNotesMetadata, filter, 0, 300, spec)
-          notes_by_date = []
-
-          pool.notes.each do |note|
-            note_datetime = DateTime.strptime(note.send(period).to_s[0...-3], '%s')
-
-            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')
-          end
-
-          notes_by_date
-        end
-
-        def find_by_date(date, period = :created)
-          filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
-          filter.words = "#{period}:year-#{year_diff(date.year)}"
-          filter.order = 1
-
-          spec = ::Evernote::EDAM::NoteStore::NotesMetadataResultSpec.new
-          spec.includeTitle = true
-          spec.includeUpdated = true
-          spec.includeCreated = true
-
-          pool = @evernote.call(:findNotesMetadata, filter, 0, 300, spec)
-          notes_by_date = []
-          
-          pool.notes.each do |note|
-            note_datetime = DateTime.strptime(note.send(period).to_s[0...-3], '%s')
-
-            notes_by_date << note if note_datetime.strftime('%m-%d-%Y') == date.strftime('%m-%d-%Y')
-          end
-
-          notes_by_date
-        end
-
-        private
-
-        def year_diff(start_year)
-          curr_year = DateTime.now.year
-          diff = curr_year - start_year
-
-          return 1 if diff == 0 || start_year > curr_year
-
-          diff
+          self if @entity
         end
+        alias_method :find_by_name, :find
 
       end
     end

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

@@ -6,19 +6,21 @@ module Evertils
       class Notebook < Entity::Base
 
         def find(name)
-          @notebook = nil
+          @entity = nil
           notebooks = Notebooks.new.all
 
           notebooks.each do |notebook|
             if notebook.name == name.to_s
-              @notebook = notebook
+              @entity = notebook
             end
           end
 
-          @notebook
+          self if @entity
         end
 
         def create(name, stack = nil)
+          @entity = nil
+
           notebook = ::Evernote::EDAM::Type::Notebook.new
           notebook.name = name
           
@@ -27,21 +29,33 @@ module Evertils
             notebook.name = "#{stack}/#{name}"
           end
           
-          @evernote.call(:createNotebook, notebook)
+          @entity = @evernote.call(:createNotebook, notebook)
+
+          self if @entity
+        end
+
+        def default
+          @entity = @evernote.call(:getDefaultNotebook)
+
+          self if @entity
+        end
+
+        def expunge!
+          @evernote.call(:expungeNotebook, @entity.guid)
         end
 
-        def expunge(name)
-          nb = find(name)
+        def expunge
+          deprecation_notice('0.2.9')
 
-          @evernote.call(:expungeNotebook, nb.guid)
+          @evernote.call(:expungeNotebook, @entity.guid)
         end
 
-        def notes(guid = nil)
+        def notes
           filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
-          filter.notebookGuid = @notebook.guid
+          filter.notebookGuid = @entity.guid
 
           notes = Notes.new
-          notes.find(nil, @notebook.guid)
+          notes.find(nil, @entity.guid)
         end
 
       end

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

@@ -27,6 +27,82 @@ module Evertils
           response.notes
         end
 
+        def find_by_tag(tag_name)
+          filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
+          filter.words = "tag:#{tag_name}"
+
+          spec = ::Evernote::EDAM::NoteStore::NotesMetadataResultSpec.new
+          spec.includeTitle = true
+
+          response = @evernote.call(:findNotesMetadata, filter, nil, 300, spec)
+          response.notes
+        end
+
+        #
+        # @since 0.2.9
+        def find_by_date_range(start, finish = DateTime.now, period = :created)
+          filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
+          filter.words = "#{period}:year-#{year_diff(start.year)}"
+          filter.order = 1
+
+          spec = ::Evernote::EDAM::NoteStore::NotesMetadataResultSpec.new
+          spec.includeTitle = true
+          spec.includeUpdated = true
+          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 << note if note_datetime.strftime('%m-%d-%Y') < finish.strftime('%m-%d-%Y') && note_datetime.strftime('%m-%d-%Y') > start.strftime('%m-%d-%Y')
+          end
+
+          notes_by_date
+        end
+
+        #
+        # @since 0.2.9
+        def find_by_date(date, period = :created)
+          filter = ::Evernote::EDAM::NoteStore::NoteFilter.new
+          filter.words = "#{period}:year-#{year_diff(date.year)}"
+          filter.order = 1
+
+          spec = ::Evernote::EDAM::NoteStore::NotesMetadataResultSpec.new
+          spec.includeTitle = true
+          spec.includeUpdated = true
+          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 << note if note_datetime.strftime('%m-%d-%Y') == date.strftime('%m-%d-%Y')
+          end
+
+          notes_by_date
+        end
+
+        private
+
+        #
+        # @since 0.2.9
+        def year_diff(start_year)
+          curr_year = DateTime.now.year
+          diff = curr_year - start_year
+
+          return 1 if diff == 0 || start_year > curr_year
+
+          diff
+        end
+
+        def note_date(note, period)
+          DateTime.strptime(note.send(period).to_s[0...-3], '%s')
+        end
+
       end
     end
   end

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

@@ -7,7 +7,7 @@ module Evertils
           begin
             nb = Notebook.new
 
-            if File.exists? full_path
+            if File.exist? full_path
               conf = YAML::load(File.open(full_path))
               required = %w(name children)
               

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

@@ -4,26 +4,33 @@ module Evertils
       class Tag < Entity::Base
 
         def find(name)
-          @tag = nil
+          @entity = nil
           tags = Tags.new.all
 
           tags.each do |tag|
             if tag.name == name.to_s
-              @tag = tag
+              @entity = tag
             end
           end
 
-          @tag
+          self if @entity
         end
 
         def create(name)
           tag = ::Evernote::EDAM::Type::Tag.new
           tag.name = name
 
-          @evernote.call(:createTag, tag)
+          @entity = @evernote.call(:createTag, tag)
+
+          self if @entity
+        end
+
+        def expunge!
+          @evernote.call(:expungeTag, @entity.guid)
         end
 
         def expunge(name)
+          deprecation_notice('0.2.9')
           tag = find(name)
 
           @evernote.call(:expungeTag, tag.guid)

data/lib/evertils/common/entity.rb

@@ -24,20 +24,22 @@ module Evertils
 
         #
         # @since 0.2.8
-        def start_of_day(date = nil)
-          date = ::Time.now unless date
-
+        def start_of_day(date = ::Time.now)
           ::Time.mktime(date.year, date.month, date.day, 12, 0, 0, 0, 0).to_datetime
         end
 
         #
         # @since 0.2.8
-        def end_of_day(date = nil)
-          date = ::Time.now unless date
-
+        def end_of_day(date = ::Time.now)
           ::Time.mktime(date.year, date.month, date.day, 23, 59, 59, 0).to_datetime
         end
 
+        #
+        # @since 0.2.9
+        def prop(name)
+          @entity.send(name)
+        end
+
       end
     end
   end

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

@@ -11,15 +11,19 @@ module Evertils
     module Query
       class Backup < Query::Base
 
-        attr_accessor :note
-
         #
         # @since 0.2.8
         def files(*files)
           date = DateTime.now
-          note = Entity::Note.new
+          nm = Entity::Note.new
+
+          @entity = nm.create("Backup: #{date}", '', 'Backup', files)
+        end
 
-          note.create("Backup: #{date.to_s}", '', 'Backup', files)
+        #
+        # @since 0.2.9
+        def expunge!
+          @entity.expunge!
         end
 
       end

data/lib/evertils/common/version.rb

@@ -1,7 +1,7 @@
 module Evertils
   module Common
 
-    VERSION = "0.2.8.2"
+    VERSION = "0.2.9"
 
   end
 end

data/lib/evertils/common.rb

@@ -12,6 +12,7 @@ require 'evertils/common/version'
 require 'evertils/common/query/backup'
 require 'evertils/common/query/simple'
 require 'evertils/common/query/time'
+require 'evertils/common/converter/yaml_to_enml'
 
 module Evertils
   module Common

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: evertils-common
 version: !ruby/object:Gem::Version
-  version: 0.2.8.2
+  version: 0.2.9
 platform: ruby
 authors:
 - Ryan Priebe