nosy 0.0.4 → 0.0.5

data/.gitignore

@@ -1 +1,5 @@
-.DS_Store
+.DS_Store
+iphone-texts.html
+iphone-texts.json
+iphone-texts.csv
+

data/README.md

@@ -12,6 +12,13 @@ Nosy returns an array of messages with the fields
 * imessage (Boolean)
 * date (contains a unix timestamp)
 
+which can then be outputted to
+
+* a html file (default)
+* a json string
+* a json document
+* a csv documents
+
 
 ## Install
 
@@ -19,7 +26,37 @@ Nosy returns an array of messages with the fields
 
 Or add Nosy to your Gemfile and run `bundle install`.
 
+## From the command line
+
+Nosy can be run from the command line using:
+
+	# Find, parse and output to an HTML file
+	$ nosy
+	
+	# … to a JSON file
+	$ nosy json true
+
+	# … to a JSON string
+	$ nosy json false
+
+	# … to a CSV file
+	$ nosy csv
+
+Note: This will only work on a Mac OSX system. Nosy (is nosy, and) will try to grab your iOS message database, parse it, and then export it, but only knows where the files are stored on a Mac system.
+
 ## Find and Parse
+If you are on a Mac OSX system, Nosy (is nosy, and) will try to grab your iOS message database, parse it, and then export it.
+
+	all_texts = Nosy.hunt_and_parse
+
+	all_texts.each do |text|
+		text.receiver
+		text.sender 
+		text.message
+		text.imessage
+		text.date
+	end
+
 If you are on a Mac OSX system, Nosy (is nosy, and) will try to grab your iOS message database and parse it.
 
 	all_texts = Nosy.hunt_and_parse
@@ -78,7 +115,7 @@ Nosy can search through the texts in your iOS message database. Nosy searching s
 * imessage
 * date - supports a Unix timestamp and an optional leading operator [ < , > , <= , >= ]
 
-#	
+Note	
 
 	nosty_texts = Nosy.new(iphone_database_location)
 	
@@ -89,7 +126,27 @@ Nosy can search through the texts in your iOS message database. Nosy searching s
 	before_then_texts = nosty_texts.search(:date => "<1273175931")
 
 	# Array of texts where I am the sender and the date is less than 1273175931
-	before_then_texts = nosty_texts.search(:sender => "me", :date => "<1273175931")
+	before_then_texts = nosty_texts.search(:sender => "me", :date => "<1273175931")`
+
+## Outputting
+
+If you provide nosy with an array of texts it will be able to output them to a html file, json string, json file, or csv. The method will return the location of the file.
+
+	# All texts to a json file
+	all_texts = Nosy.hunt_and_parse
+	Nosy.output(all_texts, "json", true)
+
+	# All texts to a json string
+	Nosy.output(all_texts, "json", false)
+
+	# Texts from me to a csv file
+	nosty_texts = Nosy.new(iphone_database_location)
+	my_sent_texts = nosty_texts.search(:sender => "me")
+	Nosy.output(my_sent_texts, "csv")
+
+	# Texts from me to a html file
+	Nosy.output(my_sent_texts, "html")
+	
 
 ## Contributions	
 Contributions, improvements, and suggestions more than welcome! Please!
@@ -101,7 +158,6 @@ Currently, Nosy is yet to...
 * Properly handle MMS (group and media) messages.
 * Let you search for two values in one key.
 * Let you hunt for the iOS message database on systems other than Mac OSX.
-* Support creating a backup file.
 * Run on Heroku due to its dependency on Sqlite3.
 
 ## Acknowledgment

data/bin/nosy

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'nosy'
+
+if ARGV[0] == nil
+  p Nosy.hunt_parse_and_output
+elsif ["html","json","csv"].include?(ARGV[0])
+  p Nosy.hunt_parse_and_output(ARGV[0], ARGV[1] == "true" ? true : false)
+elsif ["hunt","find","locate"].include?(ARGV[0])
+  p Nosy.hunt
+else
+  p Nosy.hunt_parse_and_output
+end

data/lib/nosy.rb

@@ -1,4 +1,5 @@
 require "nosy/hunter"
+require "nosy/output"
 require "nosy/parser"
 require "nosy/searcher"
 
@@ -12,6 +13,20 @@ module Nosy
       Parser.new.parse(Hunter.new.hunt)
     end
 
+    def self.hunt_parse_and_output(output_type="html", output_to_file=true)
+      if output_type == "json"
+        if output_to_file == true
+          Output.new.to_json(parse(Hunter.new.hunt), true)
+        else
+          Output.new.to_json(parse(Hunter.new.hunt), false)
+        end
+      elsif output_type == "csv"
+        Output.new.to_csv(parse(Hunter.new.hunt))
+      else
+        Output.new.to_html(parse(Hunter.new.hunt))
+      end
+    end
+
     def self.new(file)
       Searcher.new(file)
     end
@@ -23,4 +38,18 @@ module Nosy
     def self.parse(file)
       Parser.new.parse(file)
     end
+
+    def self.output(texts, output_type="html", output_to_file=true)
+      if output_type == "json"
+        if output_to_file == true
+          Output.new.to_json(texts, true)
+        else
+          Output.new.to_json(texts, false)
+        end
+      elsif output_type == "csv"
+        Output.new.to_csv(texts)
+      else
+        Output.new.to_html(texts)
+      end
+    end
 end

data/lib/nosy/output.rb

@@ -0,0 +1,49 @@
+require 'nosy/output/html_helpers'
+require 'json'
+require 'csv'
+
+module Nosy
+
+  class Output
+    include HtmlHelpers
+
+    def to_html( texts )
+      File.open("iphone-texts.html","w") do |f|
+        generate_html(f, texts)
+      end
+      "#{Dir.pwd}/iphone-texts.html"
+    end
+
+    def  to_json( texts, file=false )
+      hash = to_hash(texts)
+
+      if file == true
+        File.open("iphone-texts.json","w") do |f|
+          f.write(hash.to_json)
+        end
+        "#{Dir.pwd}/iphone-texts.json"
+      else
+        hash.to_json
+      end
+    end
+
+    def to_csv( texts, output=nil )
+      CSV.open("iphone-texts.csv", "w") do |csv|
+        csv << ["id", "date", "sender", "receiver", "message", "imessage"]
+        texts.each_with_index do |text, index|
+          csv << [index+1, text.date, text.sender, text.receiver, text.message, text.imessage]
+        end
+      end
+      "#{Dir.pwd}/iphone-texts.csv"
+    end
+
+    def to_hash (texts)
+      hash = {}
+      texts.each_with_index do |m, index|
+        hash["#{index}"] = { date: m.date, sender: m.sender, receiver: m.receiver, message: m.message, imessage: m.imessage }
+      end
+      hash
+    end
+  end
+
+end

data/lib/nosy/output/html_helpers.rb

@@ -0,0 +1,162 @@
+module Nosy
+
+  class Output
+
+    module HtmlHelpers
+
+      def generate_html(f, texts)
+        f.puts "<!doctype html><head>#{head}<style>#{css}</style></head><body><div id='container'>"
+          texts.each do |text|
+            if text.sender == "me"
+              f.puts "<article class='sending'>"
+              html_text(f, text)
+              f.puts "</article>"
+            else
+              f.puts "<article class='receiving'>"
+              html_text(f, text)
+              f.puts "</article>"
+            end
+            f.puts ""
+            f.puts "<hr />"
+            f.puts ""
+          end
+        f.puts "</div></body></html>"
+      end
+
+      def css
+      "/* http://meyerweb.com/eric/tools/css/reset/ 
+         v2.0 | 20110126
+         License: none (public domain)
+      */
+
+      html, body, div, span, applet, object, iframe,
+      h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+      a, abbr, acronym, address, big, cite, code,
+      del, dfn, em, img, ins, kbd, q, s, samp,
+      small, strike, strong, sub, sup, tt, var,
+      b, u, i, center,
+      dl, dt, dd, ol, ul, li,
+      fieldset, form, label, legend,
+      table, caption, tbody, tfoot, thead, tr, th, td,
+      article, aside, canvas, details, embed, 
+      figure, figcaption, footer, header, hgroup, 
+      menu, nav, output, ruby, section, summary,
+      time, mark, audio, video {
+        margin: 0;
+        padding: 0;
+        border: 0;
+        font-size: 100%;
+        font: inherit;
+        vertical-align: baseline;
+      }
+      /* HTML5 display-role reset for older browsers */
+      article, aside, details, figcaption, figure, 
+      footer, header, hgroup, menu, nav, section {
+        display: block;
+      }
+      body {
+        line-height: 1;
+      }
+      ol, ul {
+        list-style: none;
+      }
+      blockquote, q {
+        quotes: none;
+      }
+      blockquote:before, blockquote:after,
+      q:before, q:after {
+        content: '';
+        content: none;
+      }
+      table {
+        border-collapse: collapse;
+        border-spacing: 0;
+      }
+        
+        body{
+          background: #f9f8f6;
+          color: #606060;
+          font-family: Helvetica, Arial, sans-serif;
+          font-size: 18px;
+          line-height: 1.8333em;
+          padding: 40px 0;
+          word-wrap: break-word;
+          -webkit-font-smoothing: antialiased;
+        }
+        
+        #container{
+          width: 400px;
+          margin: 0 auto;
+          padding: 0 40px;
+        }
+        
+      hr {
+          border: none;
+          background-color: #ccc;
+          color: #ccc;
+          height: 1px;
+          margin: 45px 0;
+      }
+
+        article ul {
+          margin: 40px 0 0 0;
+        }
+        
+        article ul li {
+          font-size: 0.6777em;
+          padding: 0px;
+          line-height: 1.7em;
+        }
+        
+        article ul li.sender{
+          font-size: 1.555em;
+          font-weight: bold;
+        }
+        
+        article.sending{
+          text-align: right;
+        }"
+      end
+
+      def head 
+        "<meta charset='utf-8'>
+        <title>Texts</title>
+        <meta name='description' content=''>
+        <meta name='author' content='Nosy - pdud - Phil Dudley - iPhone Message (SMS/ iMessage) Exporter'>
+        <meta name='viewport' content='width=device-width, user-scalable=no'>
+        <!-- IE Fix for HTML5 Tags -->
+        <!--[if lt IE 9]>
+          <script src='http://html5shiv.googlecode.com/svn/trunk/html5.js'></script>
+        <![endif]-->"
+      end
+
+      def html_text (f, text)
+        f.puts "<p>#{text.message}</p>"
+        f.puts "<ul>"
+        sender_html(f, text)
+        f.puts "<li>#{Time.at(text.date).strftime('%A, %B %e, %Y at %l:%M%P')}</li>"
+      end
+
+      def sender_html(f, text)
+        if text.sender == "me"
+          f.puts "<li class='sender'>#{text.sender}</li>"
+          f.puts "<li>to #{text.receiver} via #{imessage_or_sms(f, text)}</li>"
+        else
+          f.puts "<li class='sender'>#{text.sender}</li>"
+          f.puts "<li>to #{text.receiver} via #{imessage_or_sms(f, text)}</li>"
+        end
+      end
+
+      def imessage_or_sms(f, text)
+        if text.imessage
+          "iMessage"
+        else
+          "SMS"
+        end
+      end
+
+    end
+  end
+end
+
+

data/nosy.gemspec

@@ -1,13 +1,16 @@
 Gem::Specification.new do |gem|
   gem.name        = 'nosy'
-  gem.version     = '0.0.4'
-  gem.date        = '2012-01-02'
-  gem.summary     = "Output, backup, and read all your iPhone text messages"
-  gem.description = "Nosy fetches, parses and searches the iPhone's SMS database that is created on your machine each time you make a backup."
+  gem.version     = '0.0.5'
+  gem.date        = '2012-01-08'
+  gem.summary     = "Output, backup, search, and read all your iPhone text messages"
+  gem.description = "Nosy fetches, parses and searches the iPhone's SMS database that is created on your machine each time you make a backup. It can export to HTML, CSV, or JSON."
   gem.authors     = ["Philip Dudley"]
   gem.homepage    = "https://github.com/pdud/Nosy"
   gem.email       = 'pdudley89@gmail.com'
   gem.files       = `git ls-files`.split("\n")
   gem.add_dependency("sqlite3", "~> 1.3.4")
+  gem.add_dependency("json", "~> 1.6.4")
   gem.add_development_dependency("rspec", "~> 2.6.0")
-end
+  gem.add_development_dependency("capybara", "~> 1.1.2")
+  gem.executables << 'nosy'
+end

data/spec/nosy/output_spec.rb

@@ -0,0 +1,140 @@
+require 'nosy'
+require 'spec_helper'
+
+describe Nosy::Output, "#to_json( texts )" do
+
+  let(:texts) { Nosy.parse(File.join('spec', 'support', 'db', 'texts.sqlite'))}
+
+  context "#to_html" do
+
+    before(:each) do
+      @response = subject.to_html( texts )
+      visit(@response)
+    end
+
+    it "should return the location to the created file" do
+      @response.should == "#{Dir.pwd}/iphone-texts.html"
+    end
+
+    it "should create an html document with the correct texts messages" do
+      page.all('article')[0].should have_content texts[0].message
+    end
+
+    it "should create an html document with the correct sender" do
+      page.all('article ul li.sender')[0].should have_content texts[0].sender
+      page.all('article ul li.sender')[1].should have_content texts[1].sender
+    end
+
+    it "should create an html document with the correct receiver" do
+      page.all('article')[0].find('li')[1].should have_content texts[0].receiver
+      page.all('article')[0].find('li')[1].should have_content texts[1].receiver
+    end
+
+    it "should create an html document with the imessage indicator" do
+      page.all('article')[0].find('li')[1].should have_content "SMS"
+      page.all('article')[3].find('li')[1].should have_content "iMessage"
+    end
+
+    it "should create an html document with an easy to understand date" do
+      page.all('article')[0].should have_content "Thursday, May 6, 2010 at 3:58pm"
+    end
+
+    it "should include every text" do
+      page.all('article').length.should == texts.length
+    end
+
+  end
+
+  context "#to_json" do
+
+    let(:json_texts_output) { JSON.parse( subject.to_json( texts ) ) }
+
+    describe "Output" do
+
+      it "should return a parsable json document" do
+        json_texts_output['1'].should == {"date"=>1273176415, "sender"=>"+1234567890", "receiver"=>"me", "message"=>"Okie doke, i just have my fake final at 6 to do", "imessage"=>false}
+      end
+
+      it "should include every text" do
+        json_texts_output.length.should == texts.length
+      end
+
+      it "should have a parsable date field" do
+        json_texts_output['1']['date'].should == 1273176415
+      end
+
+      it "should have a parsable sender field" do
+        json_texts_output['1']['sender'].should == "+1234567890"
+      end
+
+      it "should have a parsable receiver field" do
+        json_texts_output['1']['receiver'].should == "me"
+      end
+
+      it "should have a parsable message field" do
+        json_texts_output['1']['message'].should == "Okie doke, i just have my fake final at 6 to do"
+      end
+
+      it "should have a parsable imessage field" do
+        json_texts_output['1']['imessage'].should == false
+      end
+    end
+
+    describe "Output to file" do
+
+      before(:each) do 
+        @response = subject.to_json( texts, true ) 
+        file = File.open("iphone-texts.json")
+        @json_texts_file = JSON.parse( file.gets )
+      end
+
+      after(:each) { File.delete("iphone-texts.json")  }
+
+      it "should return the location to the created file" do
+        @response.should == "#{Dir.pwd}/iphone-texts.json"
+      end
+
+      it "should create a parsable json file" do
+          @json_texts_file['1'].should == {"date"=>1273176415, "sender"=>"+1234567890", "receiver"=>"me", "message"=>"Okie doke, i just have my fake final at 6 to do", "imessage"=>false}
+      end
+
+      it "should have the same contents as the regular output" do
+        @json_texts_file.should == json_texts_output
+      end
+    end
+  end
+
+  context "#to_csv" do
+
+    let(:csv_texts_output) { CSV.parse( subject.to_csv( texts ) )}
+
+    describe "Output to file" do
+
+      before(:each) do 
+        @response = subject.to_csv( texts, "file" )
+        @csv = CSV.read( "iphone-texts.csv", { :headers => true })
+      end
+
+      after(:each) { File.delete("iphone-texts.csv")  }
+
+      it "should return the location to the created file" do
+        @response.should == "#{Dir.pwd}/iphone-texts.csv"
+      end
+
+      it "should create a csv file" do
+        @csv[0][0].should == 1.to_s
+        @csv[0][1].should == texts[0].date.to_s
+        @csv[0][2].should == texts[0].sender
+        @csv[0][3].should == texts[0].receiver
+        @csv[0][4].should == texts[0].message
+        @csv[0][5].should == texts[0].imessage.to_s
+      end
+
+      it "should include every text" do
+        @csv.length.should == texts.length
+      end
+
+    end
+  end
+
+end

data/spec/nosy_spec.rb

@@ -4,6 +4,7 @@ describe Nosy do
 
   let(:iphone_database) { File.join('spec', 'support', 'db', 'texts.sqlite') }
   let(:texts) { subject.new(iphone_database) }
+  let(:parsed_texts) { Nosy.parse(File.join('spec', 'support', 'db', 'texts.sqlite'))}
 
   describe "#hunt" do
 
@@ -29,6 +30,30 @@ describe Nosy do
 
   end
 
+  describe "#hunt_parse_and_output( output_type, to_file)" do
+
+    it "should by default get the database, parse it, and output it as an html file" do
+      Nosy.hunt_parse_and_output.should == Nosy::Output.new.to_html(Nosy::Parser.new.parse(Nosy::Hunter.new.hunt))
+    end
+
+    it "should get the database, parse it, and output it as json string" do
+      Nosy.hunt_parse_and_output("json", false).should == Nosy::Output.new.to_json(Nosy::Parser.new.parse(Nosy::Hunter.new.hunt), false)
+    end
+
+    it "should get the database, parse it, and output it as json file" do
+      Nosy.hunt_parse_and_output("json", true).should == Nosy::Output.new.to_json(Nosy::Parser.new.parse(Nosy::Hunter.new.hunt), true)
+    end
+
+    it "should get the database, parse it, and output it as an html file" do
+      Nosy.hunt_parse_and_output("html").should == Nosy::Output.new.to_html(Nosy::Parser.new.parse(Nosy::Hunter.new.hunt))
+    end
+
+    it "should get the database, parse it, and output it as a csv file" do
+      Nosy.hunt_parse_and_output("csv").should == Nosy::Output.new.to_csv(Nosy::Parser.new.parse(Nosy::Hunter.new.hunt))
+    end
+
+  end
+
   describe "#parse" do
 
     it "should return the same results as a parse" do
@@ -45,4 +70,29 @@ describe Nosy do
 
   end
 
+  describe "#output( output_type, to_file)" do
+
+
+    it "should by default output it as an html file" do
+      Nosy.output(parsed_texts).should == Nosy::Output.new.to_html(parsed_texts)
+    end
+
+    it "should output it as json string" do
+      Nosy.output(parsed_texts, "json", false).should == Nosy::Output.new.to_json(parsed_texts, false)
+    end
+
+    it "should output it as json file" do
+      Nosy.output(parsed_texts, "json", true).should == Nosy::Output.new.to_json(parsed_texts, true)
+    end
+
+    it "should output it as an html file" do
+      Nosy.output(parsed_texts, "html").should == Nosy::Output.new.to_html(parsed_texts)
+    end
+
+    it "should output it as a csv file" do
+      Nosy.output(parsed_texts, "csv").should == Nosy::Output.new.to_csv(parsed_texts)
+    end
+
+  end
+
 end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'capybara/rspec'
+
+include Capybara::DSL
+Capybara.default_driver = :selenium
+Capybara.app_host = "file:///"
+Capybara.save_and_open_page_path = File.dirname(__FILE__) + '/../tmp'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: nosy
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-01-02 00:00:00.000000000Z
+date: 2012-01-08 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sqlite3
-  requirement: &70203490284220 !ruby/object:Gem::Requirement
+  requirement: &70361786273640 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -21,10 +21,21 @@ dependencies:
         version: 1.3.4
   type: :runtime
   prerelease: false
-  version_requirements: *70203490284220
+  version_requirements: *70361786273640
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: &70361786272420 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.6.4
+  type: :runtime
+  prerelease: false
+  version_requirements: *70361786272420
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70203490283740 !ruby/object:Gem::Requirement
+  requirement: &70361786271660 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,34 +43,51 @@ dependencies:
         version: 2.6.0
   type: :development
   prerelease: false
-  version_requirements: *70203490283740
+  version_requirements: *70361786271660
+- !ruby/object:Gem::Dependency
+  name: capybara
+  requirement: &70361786270900 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.1.2
+  type: :development
+  prerelease: false
+  version_requirements: *70361786270900
 description: Nosy fetches, parses and searches the iPhone's SMS database that is created
-  on your machine each time you make a backup.
+  on your machine each time you make a backup. It can export to HTML, CSV, or JSON.
 email: pdudley89@gmail.com
-executables: []
+executables:
+- nosy
 extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
 - .rspec
 - README.md
+- bin/nosy
 - lib/.DS_Store
 - lib/nosy.rb
 - lib/nosy/hunter.rb
+- lib/nosy/output.rb
+- lib/nosy/output/html_helpers.rb
 - lib/nosy/parser.rb
 - lib/nosy/parser/imessage.rb
 - lib/nosy/parser/message_support.rb
 - lib/nosy/parser/parse_checks.rb
 - lib/nosy/parser/smsmessage.rb
 - lib/nosy/searcher.rb
-- nosy-0.0.4.gem
+- nosy-0.0.5.gem
 - nosy.gemspec
 - spec/.DS_Store
 - spec/nosy/.DS_Store
 - spec/nosy/hunter_spec.rb
+- spec/nosy/output_spec.rb
 - spec/nosy/parser_spec.rb
 - spec/nosy/searcher_spec.rb
 - spec/nosy_spec.rb
+- spec/spec_helper.rb
 - spec/support/.DS_Store
 - spec/support/db/.DS_Store
 - spec/support/db/empty_iphone_database.sqlite
@@ -92,5 +120,5 @@ rubyforge_project:
 rubygems_version: 1.8.10
 signing_key: 
 specification_version: 3
-summary: Output, backup, and read all your iPhone text messages
+summary: Output, backup, search, and read all your iPhone text messages
 test_files: []