im_exporter 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 54c525e62df78cbf60f8c476c7081d74cae9533d
-  data.tar.gz: fafbe187fe970ad7b181997f268764d049d1607e
+  metadata.gz: 294b25e2f2c3b7e562a92bd3f6d8b0da056f2835
+  data.tar.gz: 876ab119887ca331fa73cc88e3623f566f473ee0
 SHA512:
-  metadata.gz: 3dcbfcc2eb10a56d98fa0bd135592158f887407886d2c3979107d7d5fd68d9ea0b2f3147e2f57785725b60ed505c9ccbf2367f521895705eb13762d4601b89b5
-  data.tar.gz: f2aa81f00d657db4e2974ee1e93d6d04e13fd69785ee4a9e8ca317159c8e44ba1eb8b7a1d823155ad5a2971733ed7d39326f1e012ee2da2ca00c006163b30028
+  metadata.gz: 6806f84f932e78feffeb029f0b21ffbac8f8725e863dc6057af9c7cea03368310d6670634cf07b8d51c5ad00a14c1b3e1614202e2e5a4bfc3408bdff09a20598
+  data.tar.gz: ece83a1ef28d566744a29a1976f21f9affa835d3d596d9ae982f5edb83c2e6113ba0483956d95aae25889aaa600aa619363fe43ec89960a9788265be90f1204d

data/README.md

@@ -1,12 +1,15 @@
+[![Gem Version](https://badge.fury.io/rb/im_exporter.svg)](http://badge.fury.io/rb/im_exporter)
+[![Dependency Status](https://gemnasium.com/noqcks/im_exporter.svg)](https://gemnasium.com/noqcks/im_exporter)
+
 # im_exporter CLI
 
-im_porter is an **iM**esasge **exporter** that backs up iMessage conversations to PDF or TXT files for easy reading and search
+im_porter is an **iM**esasge **exporter** that backs up iMessage conversations to PDF or TXT files for easy reading and searching
 
 ## Installation
 
 Install from the command line via
 
-  $ gem install im_exporter
+```gem install im_exporter```
 
 ## Usage
 
@@ -18,9 +21,10 @@ will output iMessage conversations in PDF documents in the pwd
 
 1. format PDF messages nicely so they look like a real iMessage conversation
 2. refactor code so it doesn't look like complete shit
+3. limit export to a specific phone number or contact name
 
 ## License
 
 Copyright (C) 2015 Ben Visser
 
-Released under the MIT License.
+Released under the MIT License.

data/Rakefile

@@ -1 +1,39 @@
-require "bundler/gem_tasks"
+require 'bundler/gem_tasks'
+require 'rubocop/rake_task'
+require 'reek/rake/task'
+require 'roodi_task'
+
+task audit: [:style, :complexity, :duplication, :design, :documentation]
+
+task style: [:rubocop]
+
+desc 'Enforce Style Conformance with RuboCop'
+RuboCop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  task.fail_on_error = false
+end
+
+task complexity: [:flog]
+
+desc 'Assess Complexity with Flog'
+# FlogTask.new :flog, 9000, ['lib']
+task :flog do
+  sh 'flog lib/**/*.rb'
+end
+
+task duplication: [:flay]
+
+task :flay do
+  sh 'flay'
+end
+
+task design: [:roodi, :reek]
+
+desc 'Find Code Smells with Reek'
+Reek::Rake::Task.new(:reek) do |task|
+  task.fail_on_error = false
+end
+
+task :documentation do
+  sh 'inch'
+end

data/bin/im_exporter

@@ -1,34 +1,34 @@
 #!/usr/bin/env ruby
 
 require 'im_exporter'
-
 require 'commander/import'
-require 'sqlite3'
 require 'prawn'
 require 'etc'
+require 'sqlite3'
 
-program :name, "iMessage Exporter CLI"
-program :version, IM_Exporter::VERSION
+program :name, 'iMessage Exporter CLI'
+program :version, IMExporter::VERSION
 program :description, 'Exports iMessage conversations as TEXT or PDF files'
 program :help, 'Authors', 'Ben Visser <theodore.r.visser@gmail.com>'
 program :help, 'Website', 'https://github.com/noqcks/im_exporter'
 default_command :help
 
-$chat_db = SQLite3::Database.new "/Users/#{Etc.getlogin}/Library/Messages/chat.db"
 $user_db = SQLite3::Database.new "/Users/#{Etc.getlogin}/Library/Application Support/AddressBook/AddressBook-v22.abcddb"
+$chat_db = SQLite3::Database.new "/Users/#{Etc.getlogin}/Library/Messages/chat.db"
 
 command :export do |c|
   c.syntax = 'export [options]'
   c.description = 'Begin the export of iMessages into a desired format'
   c.option '-f', '--format STRING', String, 'The type of format you want the iMessages outputted to [PDF, TXT]'
-  c.action do |args, options|
-    options.default :format => 'PDF'
+  c.action do |_, options|
+    options.default format: 'PDF'
+
+    contact = IMExporter::Contact
+    message = IMExporter::Message
+    attachment = IMExporter::Attachment
 
-    contact = IM_Exporter::Contact
-    message = IM_Exporter::Message
-    attachment = IM_Exporter::Attachment
+    contact.contact_ids.each do |contact_row|
 
-    contact.get_contact_ids.each do |contact_row|
       $pdf = Prawn::Document.new if options.format.eql? 'PDF'
       id = contact_row[0]
       phone = contact_row[1].delete '+'
@@ -36,15 +36,7 @@ command :export do |c|
       messages = 0
       message.read(id).each do |message_row|
         messages += 1
-        if message.is_an_attachment?(message_row[2])
-          attachment.write(message_row[3]) if options.format.eql? 'PDF'
-        else
-          if message.is_from_me?(message_row[0])
-            message.write("me", message_row[1], contact_name, options.format)
-          else
-            message.write(contact_name, message_row[1], contact_name, options.format)
-          end
-        end if message_row[4].nil?
+        message.write_logic(message_row, contact_name, options.format)
       end
       if options.format.eql? 'PDF'
         $pdf.render_file "#{contact_name}.pdf" unless messages.eql? 0

data/im_porter.gemspec

@@ -4,25 +4,30 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'im_exporter/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "im_exporter"
-  spec.version       = IM_Exporter::VERSION
-  spec.authors       = ["Ben Visser"]
-  spec.email         = ["theodore.r.visser@gmail.com"]
-  spec.summary       = %q{iMessage Exporter}
-  spec.description   = %q{Export iMessage conversations into TXT or PDF files}
-  spec.homepage      = "https://github.com/noqcks/im_exporter"
-  spec.license       = "MIT"
+  spec.name          = 'im_exporter'
+  spec.version       = IMExporter::VERSION
+  spec.authors       = ['Ben Visser']
+  spec.email         = 'theodore.r.visser@gmail.com'
+  spec.summary       = 'iMessage Exporter'
+  spec.description   = 'Export iMessage conversations into TXT or PDF files'
+  spec.homepage      = 'https://github.com/noqcks/im_exporter'
+  spec.license       = 'MIT'
 
-  spec.files         = `git ls-files -z`.split("\x0")
-  spec.executables   = ["im_exporter"]
+  spec.files         = `git ls-files`.split("\n")
+  spec.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ["lib"]
+  spec.require_paths = ['lib']
 
   spec.add_runtime_dependency 'commander', '~> 4.3', '>= 4.3.3'
   spec.add_runtime_dependency 'sqlite3', '~> 1.3.10', '>= 1.3.10'
   spec.add_runtime_dependency 'prawn', '~> 2.0.1', '>= 2.0.1'
-  spec.add_runtime_dependency 'etc', '~> 0.2.0'
+  spec.add_runtime_dependency 'etc', '~> 0.2.0',  '>= 0.2.0'
 
-  spec.add_development_dependency 'bundler', '~> 1.7'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'flog'
+  spec.add_development_dependency 'flay'
+  spec.add_development_dependency 'roodi'
+  spec.add_development_dependency 'reek'
+  spec.add_development_dependency 'inch'
 end

data/lib/im_exporter/attachment.rb

@@ -1,18 +1,23 @@
-module IM_Exporter
+# Export iMessage conversations into TXT or PDF files
+module IMExporter
+  # A module to handle attachments from the iMessage sqlite database
   module Attachment
+    # writes attachments (images) out to a PDF or TXT file
     def self.write(attachment_id)
-      $chat_db.execute('select a.filename from attachment as a join message as m on m.date = a.created_date where m.rowid=?', attachment_id) do |file_dir|
+      query = 'select a.filename from attachment as a join message as m on m.date = a.created_date where m.rowid=?'
+      $chat_db.execute(query, attachment_id) do |file_dir|
         file = file_dir.join('').sub!('~', '/Users/benvisser')
         if self.supported_file_type?(file)
-          $pdf.image file, :height => 250
+          $pdf.image file, height: 250
         else
-          $pdf.text "[IMAGE-TYPE NOT SUPPORTED]"
+          $pdf.text '[IMAGE-TYPE NOT SUPPORTED]'
         end
       end
     end
 
+    # checks whether the attachment is supported by prawn
     def self.supported_file_type?(file)
-      (file.include? "JPG" or file.include? "PNG") ? true : false
+      if file.include?('JPG') || file.include?('PNG') then true else false end
     end
   end
 end

data/lib/im_exporter/contact.rb

@@ -1,24 +1,28 @@
-module IM_Exporter
+# Export iMessage conversations into TXT or PDF files
+module IMExporter
+  # A module to handle contact lists from the iMessage sqlite database
   module Contact
+    # returns a contact name from a string that includes the contact's name and phone number
     def self.parse_contact_name_from_string(row)
-      return row.select{|element| row.count(element) > 1 }.uniq.select{ |i| i[/[a-zA-Z]/] }.join(' ')
+      row.select { |element| row.count(element) > 1 }.uniq.select { |string| string[/[a-zA-Z]/] }.join(' ')
     end
 
+    # returns the name of the contact with the specified ID and Phone number
     def self.name(id, phone)
       name = id
-      $user_db.execute('select ZSTRINGFORINDEXING from ZABCDCONTACTINDEX') do |contact|
+      query = 'select ZSTRINGFORINDEXING from ZABCDCONTACTINDEX'
+      $user_db.execute(query) do |contact|
         row = contact.join('').split(' ')
         contact_name = self.parse_contact_name_from_string(row)
         contact_phone = row.last
-        if contact_phone.eql? phone
-          name = contact_name
-        end
+        if contact_phone.eql? phone then name = contact_name end
       end
-      return name
+      name
     end
 
-    def self.get_contact_ids
-      return $chat_db.execute('select ROWID, id from handle')
+    # returns all contact IDs within the iMessage sqlitedb
+    def self.contact_ids
+      $chat_db.execute('select ROWID, id from handle')
     end
   end
 end

data/lib/im_exporter/message.rb

@@ -1,25 +1,46 @@
-module IM_Exporter
+# Export iMessage conversations into TXT or PDF files
+module IMExporter
+  # A module to handle messages from the iMessage sqlite database
   module Message
-    def self.write(user, message, file_name, type)
-      if type.eql? 'PDF'
-        $pdf.font("/Library/Fonts/Times New Roman.ttf") do
+    # writes the iMessage to a PDF or TXT document
+    def self.write(user, message, file_name, file_type)
+      if file_type.eql? 'PDF'
+        $pdf.font('/Library/Fonts/Times New Roman.ttf') do
           $pdf.text "#{user}: #{message}"
         end
       else
-        File.open("#{file_name}.txt", 'a') {|f| f.write("#{user}: #{message}\n") }
+        File.open("#{file_name}.txt", 'a') { |file| file.write("#{user}: #{message}\n") }
       end
     end
 
+    # gets metadata about each iMessage
     def self.read(id)
-      return $chat_db.execute("select is_from_me, text, cache_has_attachments, rowid, cache_roomnames from message where handle_id= ?", id)
+      select_rows = 'is_from_me, text, cache_has_attachments, rowid, cache_roomnames'
+      query = "select #{select_rows} from message where handle_id= ?"
+      $chat_db.execute(query, id)
     end
 
+    # the logic behind how things get written to the document
+    def self.write_logic(message_row, contact_name, file_type)
+      if self.is_an_attachment?(message_row[2])
+        IMExporter::Attachment.write(message_row[3]) if file_type.eql? 'PDF'
+      else
+        if self.is_from_me?(message_row[0])
+          self.write('me', message_row[1], contact_name, file_type)
+        else
+          self.write(contact_name, message_row[1], contact_name, file_type)
+        end
+      end if message_row[4].nil?
+    end
+
+    # checks whether an iMessage is from yourself
     def self.is_from_me?(message)
-      (message === 1) ? true : false
+      if message.eql? 1 then true else false end
     end
 
+    # checks whether the iMessage is actually an attachment (image)
     def self.is_an_attachment?(message)
-      (message === 1) ? true : false
+      if message.eql? 1 then true else false end
     end
   end
-end
+end

data/lib/im_exporter/version.rb

@@ -1,3 +1,4 @@
-module IM_Exporter
-  VERSION = "0.0.1"
+# Export iMessage conversations into TXT or PDF files
+module IMExporter
+  VERSION = '0.0.2'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: im_exporter
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Ben Visser
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-04 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: commander
@@ -77,6 +77,9 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -84,37 +87,109 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 0.2.0
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.2.0
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.7'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: flog
+  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: flay
+  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: roodi
+  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: reek
+  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: inch
+  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: '10.0'
+        version: '0'
 description: Export iMessage conversations into TXT or PDF files
-email:
-- theodore.r.visser@gmail.com
+email: theodore.r.visser@gmail.com
 executables:
 - im_exporter
 extensions: []
@@ -157,3 +232,4 @@ signing_key:
 specification_version: 4
 summary: iMessage Exporter
 test_files: []
+has_rdoc: