mobi 0.2.0 → 1.0.0

data/CHANGELOG.md

@@ -1,5 +1,18 @@
-= Changelog
+# Changelog
 
-== 0.1.2
+## 1.0.0
 
-* Trying to instantiate Mobi::Metadata with an invalid mobi file now raises an InvalidMobi exception 
+* No implementation changes. Bumping to 1.0 because there have been no issues raised for over a year, and just because I can!
+* Update RSpec.
+* Update Bundler.
+
+## 0.2.0
+
+* Extract EXTH header data into it's own class.
+* Parse Mobi header data.
+* Parse PalmDOC header data.
+* Large internals refactoring, and now with added tests!
+
+## 0.1.2
+
+* Trying to instantiate Mobi::Metadata with an invalid mobi file now raises an InvalidMobi exception

data/Gemfile

@@ -6,8 +6,8 @@ source "http://rubygems.org"
 # Add dependencies to develop your gem here.
 # Include everything needed to run rake, tests, features, etc.
 group :development do
-  gem 'rspec', '~> 2.11.0'
+  gem 'rspec', '~> 2.14.0'
   gem 'rr', '~> 1.0.4'
-  gem 'bundler', '~> 1.1.0'
+  gem 'bundler', '~> 1.3.0'
   gem 'jeweler', '~> 1.8.0'
 end

data/Gemfile.lock

@@ -1,7 +1,7 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    diff-lcs (1.1.3)
+    diff-lcs (1.2.4)
     git (1.2.5)
     jeweler (1.8.3)
       bundler (~> 1.0)
@@ -13,20 +13,20 @@ GEM
     rdoc (3.12)
       json (~> 1.4)
     rr (1.0.4)
-    rspec (2.11.0)
-      rspec-core (~> 2.11.0)
-      rspec-expectations (~> 2.11.0)
-      rspec-mocks (~> 2.11.0)
-    rspec-core (2.11.1)
-    rspec-expectations (2.11.1)
-      diff-lcs (~> 1.1.3)
-    rspec-mocks (2.11.1)
+    rspec (2.14.1)
+      rspec-core (~> 2.14.0)
+      rspec-expectations (~> 2.14.0)
+      rspec-mocks (~> 2.14.0)
+    rspec-core (2.14.5)
+    rspec-expectations (2.14.3)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.14.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.1.0)
+  bundler (~> 1.3.0)
   jeweler (~> 1.8.0)
   rr (~> 1.0.4)
-  rspec (~> 2.11.0)
+  rspec (~> 2.14.0)

data/{README.rdoc → README.md}

@@ -1,34 +1,40 @@
-= mobi
+# mobi
 
 A Ruby Gem that reads MOBI metadata.
 
-== Warning
+## Ruby
 
-This is still a work in progress. This gem is essentially made up of me playing around with the mobi file and extracting data.
+Compatible up to ruby 2.0.0p0.
 
-The gem does NOT handle any errors in a mobi document, or some edge cases.
+I haven't tested beyond that version, but it should work.
 
-Tests will be added soon.
+## Installation
 
-== Installation
+`gem install mobi`
 
-  gem install mobi
-
-== Usage
+## Usage
 
 Creating a Mobi::Metadata object
 
-  Mobi::Metadata.new(File.open('/path/to/file.mobi'))
-  
+```ruby
+Mobi::Metadata.new(File.open('/path/to/file.mobi'))
+```
+
 A handy convenience method to do the exact same thing
 
-  Mobi.metadata File.open('/path/to/file.mobi')
-  
+```ruby
+Mobi.metadata File.open('/path/to/file.mobi')
+```
+
 Getting metadata information is as simple as:
 
-  metadata = Mobi.metadata File.open('/path/to/file.mobi')
-  author = metadata.author
-  
+```ruby
+metadata = Mobi.metadata File.open('/path/to/fellowship_of_the_ring.mobi')
+#=> #<Mobi::Metadata>
+metadata.author
+#=> "J.R.R. Tolkien"
+```
+
 Supported metadata options are:
 
 * author
@@ -47,12 +53,32 @@ Supported metadata options are:
 * asin
 * version
 
-== Thanks
+You can also drill down and get the PalmDOC and MOBI header details:
+
+```ruby
+palm_doc_header = metadata.palm_doc_header
+#=> #<Mobi::Header::PalmDocHeader>
+palm_doc_header.raw_compression_type
+#=> 2
+palm_doc_header.compression_type
+#=> "PalmDOC"
+
+mobi_header = metadata.mobi_header
+#=> #<Mobi::Header::MobiHeader>
+mobi_header.raw_mobi_type
+#=> 2
+mobi_header.mobi_type
+#=> "MOBIpocket Book"
+```
+
+See the source for more methods.
+
+## Thanks
+
+* Calibre open source project. I ripped off the idea of a Stream Slicer and got a better understanding of MOBI files from their code base. Check them out at http://calibre-ebook.com
 
-* Calibre open source project. I ripped off the idea of a Stream Slicer and got a better understanding of mobi files from their code base. Check them out at http://calibre-ebook.com
+## Contributing to mobi
 
-== Contributing to mobi
- 
 * Check out the latest master to make sure the feature hasn't been implemented or the bug hasn't been fixed yet
 * Check out the issue tracker to make sure someone already hasn't requested it and/or contributed it
 * Fork the project
@@ -61,8 +87,7 @@ Supported metadata options are:
 * Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
 * Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
 
-== Copyright
+## Copyright
 
-Copyright (c) 2011 jkongie. See LICENSE.txt for
-further details.
+Copyright (c) 2011 jkongie. See LICENSE.txt for further details.
 

data/VERSION

@@ -1 +1 @@
-0.2.0
+1.0.0

data/mobi.gemspec

@@ -5,16 +5,16 @@
 
 Gem::Specification.new do |s|
   s.name = "mobi"
-  s.version = "0.2.0"
+  s.version = "1.0.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["jkongie"]
-  s.date = "2012-08-06"
+  s.date = "2013-10-04"
   s.description = "Mobi is a Rubygem that allows you to easily read MOBI e-book format metadata."
   s.email = "jkongie@gmail.com"
   s.extra_rdoc_files = [
     "LICENSE.txt",
-    "README.rdoc"
+    "README.md"
   ]
   s.files = [
     ".document",
@@ -23,7 +23,7 @@ Gem::Specification.new do |s|
     "Gemfile",
     "Gemfile.lock",
     "LICENSE.txt",
-    "README.rdoc",
+    "README.md",
     "Rakefile",
     "VERSION",
     "lib/mobi.rb",
@@ -46,27 +46,27 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/jkongie/mobi"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.23"
   s.summary = "A Rubygem that inspects MOBI metadata."
 
   if s.respond_to? :specification_version then
     s.specification_version = 3
 
     if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_development_dependency(%q<rspec>, ["~> 2.11.0"])
+      s.add_development_dependency(%q<rspec>, ["~> 2.14.0"])
       s.add_development_dependency(%q<rr>, ["~> 1.0.4"])
-      s.add_development_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_development_dependency(%q<bundler>, ["~> 1.3.0"])
       s.add_development_dependency(%q<jeweler>, ["~> 1.8.0"])
     else
-      s.add_dependency(%q<rspec>, ["~> 2.11.0"])
+      s.add_dependency(%q<rspec>, ["~> 2.14.0"])
       s.add_dependency(%q<rr>, ["~> 1.0.4"])
-      s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+      s.add_dependency(%q<bundler>, ["~> 1.3.0"])
       s.add_dependency(%q<jeweler>, ["~> 1.8.0"])
     end
   else
-    s.add_dependency(%q<rspec>, ["~> 2.11.0"])
+    s.add_dependency(%q<rspec>, ["~> 2.14.0"])
     s.add_dependency(%q<rr>, ["~> 1.0.4"])
-    s.add_dependency(%q<bundler>, ["~> 1.1.0"])
+    s.add_dependency(%q<bundler>, ["~> 1.3.0"])
     s.add_dependency(%q<jeweler>, ["~> 1.8.0"])
   end
 end

data/spec/lib/mobi/metadata_spec.rb

@@ -3,11 +3,14 @@ require 'spec_helper'
 require 'mobi'
 
 describe Mobi::Metadata do
-  let(:file){ File.open('spec/fixtures/sherlock.mobi') }
+  before :all do
+    @file = File.open('spec/fixtures/sherlock.mobi')
+  end
+
 
   context 'initialization' do
     it 'should instantiate a StreamSlicer from the file' do
-      metadata = Mobi::Metadata.new(file)
+      metadata = Mobi::Metadata.new(@file)
 
       metadata.data.should be_instance_of(Mobi::StreamSlicer)
     end
@@ -17,12 +20,12 @@ describe Mobi::Metadata do
         mock(m).bookmobi? { false }
       end
 
-      lambda{ Mobi::Metadata.new(file) }.should raise_exception(Mobi::Metadata::InvalidMobi)
+      lambda{ Mobi::Metadata.new(@file) }.should raise_exception(Mobi::Metadata::InvalidMobi)
     end
 
     context 'instantiating headers' do
       before :all do
-        @metadata = Mobi::Metadata.new(file)
+        @metadata = Mobi::Metadata.new(@file)
       end
 
       it 'should instantiate a palm doc header' do
@@ -41,7 +44,7 @@ describe Mobi::Metadata do
 
   context 'instance' do
     before :all do
-      @metadata = Mobi::Metadata.new(file)
+      @metadata = Mobi::Metadata.new(@file)
     end
 
     it 'gets the the title of the book' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: mobi
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-08-06 00:00:00.000000000 Z
+date: 2013-10-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rspec
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 2.11.0
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: rr
   requirement: !ruby/object:Gem::Requirement
@@ -50,7 +50,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -58,7 +58,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: jeweler
   requirement: !ruby/object:Gem::Requirement
@@ -81,7 +81,7 @@ executables: []
 extensions: []
 extra_rdoc_files:
 - LICENSE.txt
-- README.rdoc
+- README.md
 files:
 - .document
 - .rspec
@@ -89,7 +89,7 @@ files:
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
-- README.rdoc
+- README.md
 - Rakefile
 - VERSION
 - lib/mobi.rb
@@ -123,7 +123,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -4390425668178990085
+      hash: -833991204484823128
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -132,7 +132,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
 summary: A Rubygem that inspects MOBI metadata.