evertils-common 0.3.2 → 0.3.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 5373e916dd2c6812cf51d1fb29552c4a31e4e849
-  data.tar.gz: 411679ae6c66dfc2f84ed56eae1195409409a5b5
+  metadata.gz: da7fb7a8194a9a61a880bd69f81560d0c9953fb0
+  data.tar.gz: 679cfc257b94ef09559aa88da2822783e1d62502
 SHA512:
-  metadata.gz: 31a683b20d62bff159d805ecff5345b9dd1e2d78673b10859f2886af7ec724bdb97fc142fe7dcfbcc9b566097f6defa71e78e70c015523a9d596b04f31e9e7f7
-  data.tar.gz: 98d9a69fedef985a87162eacdf63674fd771ac1bddd45e3ac5f04356c9c60100bfd5f25e13844e35d7c8bf1197291b66f97239910f0eb1bedb7707764b48a49d
+  metadata.gz: 52a08dee5ad59a1e937982b49e0ee0e5b5fdc51071fd2db3ce28e9a366c0eb133fa53be4b38cbda71ace5a1fddd8fd8ff09726bdc36aa97c3d00d62d164b03fa
+  data.tar.gz: d0fdf469724242135b11e9a2c9cdb607ca259058e097145c4499f2754b90d03b9ded0798f4003c45a77a3f1967172cf0430fab3af15dfbe2abb868934a75e9f1

data/lib/evertils/common/authentication.rb

@@ -134,7 +134,7 @@ module Evertils
         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
+          minutes = (e.rateLimitDuration.to_i/60).to_i
           message = "You are rate limited!  Wait #{minutes} minutes"
         end
 

data/lib/evertils/common/enmlelement.rb

@@ -0,0 +1,36 @@
+module Evertils
+  module Common
+    class ENMLElement
+      #
+      # @since 0.3.3
+      def initialize
+        @enml = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
+        @enml += "<!DOCTYPE en-note SYSTEM \"http://xml.evernote.com/pub/enml2.dtd\">"
+      end
+
+      #
+      # @since 0.3.3
+      def body=(content)
+        @enml += "<en-note>#{content}</en-note>"
+      end
+
+      #
+      # @since 0.3.3
+      def to_s
+        @enml.to_s.encode(Encoding::UTF_8)
+      end
+
+      # Required as part of the thrift data conversion
+      # @since 0.3.3
+      def encoding
+        Encoding::UTF_8
+      end
+
+      # Required as part of the thrift data conversion
+      # @since 0.3.3
+      def force_encoding(enc)
+        @enml.to_s.encode(enc)
+      end
+    end
+  end
+end

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

@@ -5,7 +5,7 @@ module Evertils
         #
         # @since 0.2.0
         def create_from_yml(full_path)
-          return unless File.exist? full_path
+          raise "File not found: #{full_path}" unless File.exist? full_path
 
           begin
             conf = YAML::load(File.open(full_path))
@@ -23,72 +23,18 @@ module Evertils
 
         #
         # @since 0.2.0
-        def create(title, body, parent_notebook = nil, file = nil, share_note = false, created_on = nil)
-          @entity = nil
-
-          # final output
-          output = {}
-
-          # Create note object
-          our_note = ::Evernote::EDAM::Type::Note.new
-          our_note.resources = []
-          our_note.tagNames = []
-
-          # a file was requested, lets prepare it for storage
-          if file
-            if file.is_a? Array
-              file.each do |f|
-                media_resource = ENML.new(f)
-                body.concat(media_resource.embeddable_element)
-                our_note.resources << media_resource.element
-              end
-            else
-              media_resource = ENML.new(file)
-              body.concat(media_resource.embeddable_element)
-              our_note.resources << media_resource.element
-            end
-          end
-
-          # only join when required
-          body = body.join if body.is_a? Array
-
-          n_body = "<?xml version=\"1.0\" encoding=\"UTF-8\"?>"
-          n_body += "<!DOCTYPE en-note SYSTEM \"http://xml.evernote.com/pub/enml2.dtd\">"
-          n_body += "<en-note>#{body}</en-note>"
-
-          # setup note properties
-          our_note.title = title
-          our_note.content = n_body
-          our_note.created = created_on if !created_on.is_a?(DateTime)
-
-          if !parent_notebook.is_a? Evertils::Common::Entity::Notebook
-            nb = Entity::Notebook.new
-            parent_notebook = nb.find(parent_notebook)
-            parent_notebook = nb.default if parent_notebook.nil?
-          end
-
-          # parent_notebook is optional; if omitted, default notebook is used
-          our_note.notebookGuid = parent_notebook.to_s
+        def create(conf = {})
+          note = Evertils::Common::Model::Note.new(conf)
+          @entity = @evernote.call(:createNote, note.entity)
 
-          # Attempt to create note in Evernote account
-          begin
-            @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
-            ## Parent Notebook GUID doesn't correspond to an actual notebook
-            Notify.error "EDAMNotFoundException: Invalid parent notebook GUID"
-          rescue ArgumentError => e
-            Notify.error e.backtrace
-          end
+          return false unless @entity
 
-          Notify.success("#{parent_notebook.prop(:stack)}/#{parent_notebook.prop(:name)}/#{our_note.title} created")
+          share if note.shareable
 
-          self if @entity
+          # TODO: get metadata back so we can print stack/notebook info
+          # Notify.success("#{note.notebook.prop(:stack)}/#{note.notebook.prop(:name)}/#{note.entity.title} created")
+          Notify.success("#{note.entity.title} created")
+          self
         end
 
         #
@@ -120,7 +66,7 @@ module Evertils
         #
         # @since 0.2.9
         def move_to(notebook)
-          nb = Evertils::Common::Manager::Notebook.new
+          nb = Evertils::Common::Manager::Notebook.instance
           target = nb.find(notebook)
 
           raise "Notebook not found: #{notebook}" if target.entity.nil?
@@ -172,6 +118,24 @@ module Evertils
 
           @evernote.call(:updateNote, @entity)
         end
+
+        #
+        # @since 0.3.3
+        def attach_file(file)
+          if file.is_a? Array
+            file.each do |f|
+              media_resource = ENML.new(f)
+              body.concat(media_resource.embeddable_element)
+              @entity.resources << media_resource.element
+            end
+          else
+            media_resource = ENML.new(file)
+            body.concat(media_resource.embeddable_element)
+            @entity.resources << media_resource.element
+          end
+
+          @evernote.call(:updateNote, @entity)
+        end
       end
     end
   end

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

@@ -11,24 +11,22 @@ module Evertils
         #
         # @since 0.1.0
         def create_from_yml(full_path)
+          raise "File not found: #{full_path}" unless File.exist? full_path
+
           begin
             nb = Notebook.new
 
-            if File.exists? full_path
-              conf = YAML::load(File.open(full_path))
-              required = %w(notebooks)
+            conf = YAML::load(File.open(full_path))
+            required = %w(notebooks)
 
-              if has_required_fields(conf, required)
-                if !conf["notebooks"].nil?
-                  conf["notebooks"].each do |name|
-                    nb.create(name)
-                  end
+            if has_required_fields(conf, required)
+              if !conf["notebooks"].nil?
+                conf["notebooks"].each do |name|
+                  nb.create(name)
                 end
-              else
-                raise ArgumentError, 'Configuration file is missing some required fields'
               end
             else
-              raise ArgumentError, "File not found: #{full_path}"
+              raise ArgumentError, 'Configuration file is missing some required fields'
             end
           rescue ArgumentError => e
             puts e.message

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

@@ -3,24 +3,22 @@ module Evertils
     module Entity
       class Stack < Entity::Base
         def create_from_yml(full_path)
+          raise "File not found: #{full_path}" unless File.exist? full_path
+
           begin
             nb = Notebook.new
 
-            if File.exist? full_path
-              conf = YAML::load(File.open(full_path))
-              required = %w(name children)
+            conf = YAML::load(File.open(full_path))
+            required = %w(name children)
 
-              if has_required_fields(conf, required)
-                if !conf["children"].nil?
-                  conf["children"].each do |name|
-                    nb.create(name, conf["name"])
-                  end
+            if has_required_fields(conf, required)
+              if !conf["children"].nil?
+                conf["children"].each do |name|
+                  nb.create(name, conf["name"])
                 end
-              else
-                raise ArgumentError, 'Configuration file is missing some required fields'
               end
             else
-              raise ArgumentError, "File not found: #{full_path}"
+              raise ArgumentError, 'Configuration file is missing some required fields'
             end
           rescue ArgumentError => e
             puts e.message

data/lib/evertils/common/entity.rb

@@ -2,7 +2,7 @@ module Evertils
   module Common
     module Entity
       class Base < Common::Generic
-        attr_accessor :evernote, :entity
+        attr_accessor :entity
 
         def initialize
           @evernote = Authentication.instance

data/lib/evertils/common/generic.rb

@@ -20,7 +20,23 @@ module Evertils
       def deprecation_notice(version, message)
         output = "Deprecated as of #{version}"
         output += "\nReason: #{message}" if message
-        output
+        Notify.spit(output)
+      end
+
+      # Required as part of the thrift data conversion
+      # @since 0.3.3
+      def encoding
+        Encoding::UTF_8
+      end
+
+      # Required as part of the thrift data conversion
+      # @since 0.3.3
+      def force_encoding(enc)
+      end
+
+      # Required as part of the thrift data conversion
+      # @since 0.3.3
+      def bytesize(enc)
       end
     end
   end

data/lib/evertils/common/kernel.rb

@@ -2,4 +2,22 @@ class String
   def capitalize_first_char
     self.sub(/^(.)/) { $1.capitalize }
   end
+end
+
+# required for some reason, thrift is weird
+class Hash
+  def encoding
+  end
+
+  def encode(arg)
+  end
+
+  def force_encoding(arg)
+  end
+end
+
+class NilClass
+  def bytesize
+    0
+  end
 end

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

@@ -1,12 +1,16 @@
+require "singleton"
+
 module Evertils
   module Common
     module Manager
       class Note < Manager::Base
+        include Singleton
+
         #
         # @since 0.3.0
         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.create(config)
           entity
         end
 

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

@@ -1,7 +1,11 @@
+require "singleton"
+
 module Evertils
   module Common
     module Manager
       class Notebook < Manager::Base
+        include Singleton
+
         #
         # @since 0.3.0
         def create(name, stack = nil)

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

@@ -1,7 +1,11 @@
+require "singleton"
+
 module Evertils
   module Common
     module Manager
       class Sync < Manager::Base
+        include Singleton
+
         #
         # @since 0.3.0
         def state

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

@@ -1,7 +1,11 @@
+require "singleton"
+
 module Evertils
   module Common
     module Manager
       class Tag < Manager::Base
+        include Singleton
+
         #
         # @since 0.3.0
         def create(name)

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

@@ -0,0 +1,118 @@
+require 'evertils/common/enmlelement'
+require 'evertils/common/enml'
+
+module Evertils
+  module Common
+    module Model
+      class Note
+        attr_accessor :shareable, :updated
+
+        #
+        # @since 0.3.3
+        def initialize(conf = {})
+          raise "Title (title) is a required field" unless conf[:title]
+          raise "Body (body) is a required field" unless conf[:body]
+
+          @note = ::Evernote::EDAM::Type::Note.new
+
+          # data which maps directly to the Type::Note object
+          self.body = conf[:body]
+          self.created = conf[:created_on] || DateTime.now
+
+          @note.title = conf[:title]
+          @note.tagNames = conf[:tags] || []
+          @note.resources = []
+
+          # data that must be processed first
+          @notebook = conf[:parent_notebook] || Entity::Notebook.new.default.to_s
+          @resources = conf[:file] || []
+          @shareable = conf[:share_note] || false
+          @updated = conf[:updated_on] || nil
+
+          attach_resources
+          attach_notebook
+        end
+
+        # Accessor for the title property
+        # @since 0.3.3
+        def title
+          @note.title
+        end
+
+        # Accessor for the body/content property
+        # @since 0.3.3
+        def body
+          @note.content
+        end
+        alias content body
+
+        # Accessor for the notebook property
+        # @since 0.3.3
+        def notebook
+          @note.notebookGuid
+        end
+
+        # Accessor for the tagNames property
+        # @since 0.3.3
+        def tags
+          @note.tagNames
+        end
+
+        # Accessor for the created_on property
+        # @since 0.3.3
+        def created
+          @note.created
+        end
+
+        # The whole note
+        # @since 0.3.3
+        def entity
+          @note
+        end
+
+        protected
+
+        # Body content must be valid ENML so we create that here
+        # @since 0.3.3
+        def body=(content)
+          note_body = ENMLElement.new
+          note_body.body = content
+
+          @note.content = note_body.to_s
+        end
+
+        #
+        # @since 0.3.3
+        def created=(date)
+          date = DateTime.now unless date
+          created_on = (date.to_time.to_i.to_s + "000").to_i
+
+          @note.created = created_on
+        end
+
+        private
+
+        def attach_resources
+          if @resources.is_a? Array
+            @resources.each do |f|
+              media_resource = ENML.new(f)
+              content.concat(media_resource.embeddable_element)
+              @note.resources << media_resource.element
+            end
+          else
+            media_resource = ENML.new(@resources)
+            content.concat(media_resource.embeddable_element)
+            @note.resources << media_resource.element
+          end
+        end
+
+        def attach_notebook
+          nb = Manager::Notebook.instance
+          query = nb.find(@notebook.to_s)
+          notebook = query.entity
+          @note.notebookGuid = notebook if query
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,8 @@
+module Evertils
+  module Common
+    module Model
+      class Notebook
+      end
+    end
+  end
+end

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

@@ -17,7 +17,7 @@ module Evertils
             nb = nb_entity.create(backup_notebook_name)
           end
 
-          @entity = nm.create("Backup: #{date}", "", nb, files)
+          @entity = nm.create(title: "Backup: #{date}", body: "", parent_notebook: nb, files: files)
         end
 
         #

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

@@ -17,66 +17,66 @@ module Evertils
         #
         # @since 0.2.0
         def notes_by_notebook(name)
-          entity = Manager::Notebook.new
+          entity = Manager::Notebook.instance
           nb = entity.find(name)
           nb.notes
         end
 
         #
         # @since 0.2.0
-        def create_stack_from(full_path)
+        def create_stack_from_yml(full_path)
           stack = Entity::Stack.new
           stack.create_from_yml(full_path)
         end
 
         #
         # @since 0.2.0
-        def create_note_from(full_path)
+        def create_note_from_yml(full_path)
           entity = Entity::Note.new
-          note = entity.create_from_yml(full_path)
+          entity.create_from_yml(full_path)
         end
 
         #
         # @since 0.2.0
-        def create_notebooks_from(full_path)
+        def create_notebooks_from_yml(full_path)
           entity = Entity::Notebooks.new
-          nb = entity.create_from_yml(full_path)
+          entity.create_from_yml(full_path)
         end
 
         #
         # @since 0.2.0
         def create_notebook(name, stack = nil)
           entity = Entity::Notebook.new
-          nb = entity.create(name, stack)
+          entity.create(name, stack)
         end
 
         #
         # @since 0.3.1
         def create_tag(name)
-          entity = Manager::Tag.new
-          tag = entity.create(name)
+          entity = Manager::Tag.instance
+          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)
+        # @since 0.3.3
+        def create_note_from_hash(conf)
+          entity = Manager::Note.instance
+          entity.create(conf)
         end
+        alias create_note create_note_from_hash
 
         #
         # @since 0.2.0
         def find_note(name)
-          entity = Manager::Note.new
-          note = entity.find(name)
+          entity = Manager::Note.instance
+          entity.find(name)
         end
 
         #
         # @since 0.3.1
         def find_notebook(name)
-          entity = Manager::Notebook.new
-          nb = entity.find(name)
+          entity = Manager::Notebook.instance
+          entity.find(name)
         end
 
         #
@@ -85,14 +85,14 @@ module Evertils
         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)
+          entity = Manager::Notebook.instance
+          entity.find(name)
         end
 
         #
         # @since 0.2.0
         def note_exists(name)
-          entity = Manager::Note.new
+          entity = Manager::Note.instance
           note = entity.find(name)
           note.exists?
         end
@@ -100,7 +100,7 @@ module Evertils
         #
         # @since 0.2.0
         def destroy_note(name)
-          entity = Manager::Note.new
+          entity = Manager::Note.instance
           note = entity.find(name)
           note.expunge!
         end
@@ -108,14 +108,8 @@ module Evertils
         #
         # @since 0.2.0
         def poll
-          begin
-            sync = Entity::Sync.new
-            sync.state
-          rescue Evernote::EDAM::Error::EDAMSystemException => e
-            if e.errorCode == 19
-              puts "You're rate limited, wait #{e.rateLimitDuration}s"
-            end
-          end
+          sync = Entity::Sync.new
+          sync.state
         end
       end
     end

data/lib/evertils/common/version.rb

@@ -1,5 +1,5 @@
 module Evertils
   module Common
-    VERSION = "0.3.2".freeze
+    VERSION = "0.3.3".freeze
   end
 end

data/lib/evertils/common.rb

@@ -4,24 +4,31 @@ require 'yaml'
 require 'mime/types'
 require 'date'
 
+# core files
 require 'evertils/common/kernel'
 require 'evertils/common/generic'
-require 'evertils/common/enml'
 require 'evertils/common/entity'
 require 'evertils/common/query'
 require 'evertils/common/converter'
 require 'evertils/common/manager'
 require 'evertils/common/version'
 
+# models represent Evernote's Data types
+# https://dev.evernote.com/doc/reference/Types.html#Struct_Note
+require 'evertils/common/model/note'
+
+# wrappers to perform common queries on your EN data
 require 'evertils/common/query/simple'
 require 'evertils/common/query/time'
 require 'evertils/common/query/backup'
 
+# simple wrappers for the often complex entity objects
 require 'evertils/common/manager/note'
 require 'evertils/common/manager/notebook'
 require 'evertils/common/manager/sync'
 require 'evertils/common/manager/tag'
 
+# do stuff with your EN data
 require 'evertils/common/entity/notebook'
 require 'evertils/common/entity/notebooks'
 require 'evertils/common/entity/notes'
@@ -31,6 +38,7 @@ require 'evertils/common/entity/tags'
 require 'evertils/common/entity/sync'
 require 'evertils/common/entity/stack'
 
+# convert from ENML (Evernote Markup Language) to another data type
 require 'evertils/common/converter/yaml_to_enml'
 
 module Evertils

data/lib/evertils/test/base.rb

@@ -3,7 +3,6 @@ require 'minitest/autorun'
 module Evertils
   module Test
     class Base < Minitest::Test
-
       # Run before all tests (check the Rakefile for specifics)
       # @since 0.3.0
       def self.before
@@ -32,14 +31,11 @@ module Evertils
       #
       # @since 0.3.0
       def setup
-        entity = Evertils::Common::Manager::Sync.new
+        entity = Evertils::Common::Manager::Sync.instance
 
-        @@test_time = Time.now.to_i
+        Notify.error('Could not determine connection to the Evernote API, exiting') unless entity.state.is_a?(Evernote::EDAM::NoteStore::SyncState)
 
-        if !entity.state.is_a?(Evernote::EDAM::NoteStore::SyncState)
-          puts 'Could not determine connection to the Evernote API, exiting'
-          exit(1)
-        end
+        @@test_time = Time.now.to_i
       end
 
       #
@@ -58,15 +54,15 @@ module Evertils
           conf.each do |stack_name|
             stack_name.last.each_pair do |key, arr|
               puts "Creating: #{stack_name.first}/#{key}-#{@@test_time}..."
-              ch_nb = nb.create("#{key}-#{@@test_time}", stack_name.first)
+              ch_nb = nb.create({ title: "#{key}-#{@@test_time}" }, stack_name.first)
 
               arr.each do |child_note|
                 child_note.each_pair do |name, options|
                   puts "Creating: #{stack_name.first}/#{key}/#{name}.note..."
                   parsed = DateTime.parse(options['created_on'])
 
-                  created_on = (parsed.to_time.to_i.to_s + "000").to_i
-                  note.create(name, "Body for test note", ch_nb, nil, false, created_on)
+                  # created_on = (parsed.to_time.to_i.to_s + "000").to_i
+                  note.create(title: name, body: "Body for test note", parent_notebook: ch_nb, created_on: parsed)
                 end
               end
             end
@@ -82,7 +78,7 @@ module Evertils
       # @since 0.3.0
       def clean
         nb = Evertils::Common::Entity::Notebooks.new
-        nbm = Evertils::Common::Manager::Notebook.new
+        nbm = Evertils::Common::Manager::Notebook.instance
         notes = Evertils::Common::Entity::Notes.new
         auth = Evertils::Common::Authentication.instance
         tm = Evertils::Common::Entity::Tags.new
@@ -119,7 +115,6 @@ module Evertils
 
         puts "Sample data deleted"
       end
-
     end
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: evertils-common
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.3.3
 platform: ruby
 authors:
 - Ryan Priebe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-07-26 00:00:00.000000000 Z
+date: 2016-08-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -105,6 +105,7 @@ files:
 - lib/evertils/common/converter.rb
 - lib/evertils/common/converter/yaml_to_enml.rb
 - lib/evertils/common/enml.rb
+- lib/evertils/common/enmlelement.rb
 - lib/evertils/common/entity.rb
 - lib/evertils/common/entity/note.rb
 - lib/evertils/common/entity/notebook.rb
@@ -121,6 +122,8 @@ files:
 - lib/evertils/common/manager/notebook.rb
 - lib/evertils/common/manager/sync.rb
 - lib/evertils/common/manager/tag.rb
+- lib/evertils/common/model/note.rb
+- lib/evertils/common/model/notebook.rb
 - lib/evertils/common/query.rb
 - lib/evertils/common/query/backup.rb
 - lib/evertils/common/query/simple.rb