megar 0.0.1

data/.gitignore

@@ -0,0 +1,19 @@
+*.gem
+*.rbc
+*.trace
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+spec/sandpit
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3@megar --create

data/.travis.yml

@@ -0,0 +1,11 @@
+# These are specific configuration settings required for travis-ci
+# see http://travis-ci.org/evendis/megar
+language: ruby
+rvm:
+  # - 1.8.7
+  # - 1.9.2
+  - 1.9.3
+  # - rbx-18mode
+  # - rbx-19mode
+  # - jruby-18mode
+  # - jruby-19mode

data/CHANGELOG

@@ -0,0 +1,5 @@
+0.0.1 Preliminary Release  26-Feb-2013
+======================================
+* An initial release with minimal functionality
+* API support: connect and get file/folder listings
+* basic CLI to connect and get file listing

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in megar.gemspec
+gemspec

data/Guardfile

@@ -0,0 +1,11 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'rspec', :version => 2, :all_on_start => false, :all_after_pass => false do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/megar/(.+)\.rb$})     { |m| "spec/unit/#{m[1]}_spec.rb" }
+  watch(%r{^lib/extensions/(.+)\.rb$})     { |m| "spec/unit/extensions/#{m[1]}_spec.rb" }
+  watch('spec/spec_helper.rb')  { "spec" }
+
+end
+

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Paul Gallagher
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.rdoc

@@ -0,0 +1,218 @@
+= Megar {<img src="https://secure.travis-ci.org/tardate/megar.png" />}[http://travis-ci.org/tardate/megar]
+
+Megar ("megaargh!" in pirate-speak) is a Ruby wrapper and command-line (CLI) client for the {Mega API}[https://mega.co.nz/#developers].
+
+It needs a few more API functions implemented to make it halfway useful, but it's a start.
+You can connect and get file/folder listings at the moment.
+
+== Requirements and Known Limitations
+
+Consider this totally alpha at this point, especially since the Mega API has yet to be formally and fully documented.
+
+* Currently tested with MRI 1.9.3
+* MRI 1.9.2 and 2.x not yet tested
+* Rubinius and JRuby 1.9 modes not yet tested
+* No plans to support 1.8 Ruby branches
+
+Mega API coverage is far from complete at this point (help appreciated!). Here's the run-down:
+
+Supported API functions:
+* User/session management: Complete accounts
+* Login session challenge/response
+* Retrieve file and folder nodes
+
+Currently unsupported API functions:
+* User/session management: Ephemeral accounts
+* User/session management: Confirming accounts
+* Retrieve user nodes
+* Add/copy nodes
+* Delete node
+* Move node
+* Set node attributes
+* Create/delete public handle
+* Create/modify/delete outgoing share
+* Key handling - Set or request share/node keys
+* Request download URL
+* Request upload URL
+* Add/update user
+* Get user
+* Retrieve user's public key
+* Add/update/delete contact
+* Invite user
+* Send confirmation e-mail
+* Obtain user details by invitation code
+* Verify e-mailed confirmation code
+* List user sessions
+* User quota details
+* ... and any other API features not explicitly listed above
+
+
+== The Megar Cookbook
+
+=== How do I install it for normal use?
+
+Add this line to your application's Gemfile:
+
+    gem 'megar'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install megar
+
+
+=== How to start an authenticated session
+
+The Megar::Session object is the main entry point for the library.
+All requests on the Mega API are made in the context of an established session.
+
+    # create a session with immediate authentication
+    session = Megar::Session.new(email: 'my@email.com', password: 'my_password')
+
+It's possible to delay the authentication
+
+    # create a session with deferred authentication
+    session = Megar::Session.new(email: 'my@email.com', password: 'my_password', autoconnect: false )
+    # then explicitly login:
+    session.connect!
+
+=== How to get a listing of all folders
+
+Folders are accessed through an authenticated <tt>Megar::Session</tt> object.
+
+    all_folders = session.folders
+
+<tt>folders</tt> is an enumerable collection, so you can iterate as you would expect:
+
+    session.folders.each do |folder|
+      puts folder.name
+    end
+
+=== How to get a handle to the special Mega folders
+
+In addition to any folders you create yourself, Mega provides three standard folders:
+root ("Cloud Drive"), inbox and trash. Shortcuts are available on the folders collection to
+grab a handle on these directly:
+
+    my_folders = session.folders
+    my_folders.root
+    my_folders.inbox
+    my_folders.trash
+
+=== What are all the attributes of a folder?
+
+Once you have a folder object (e.g. <tt>session.folders.first</tt>), the following are the
+primary attributes it exposes:
+
+* id: the unique ID, corresponds to the Mega node handle
+* name: the name of the folder
+
+
+=== How to get a listing of all files in a folder
+
+A folder node provides a files collection
+
+    session.folders.first.files.each do |file|
+      puts file.name
+    end
+
+
+=== How to get a listing of all files
+
+All files can be accessed directly without needing to navigate via a folder object.
+
+    all_files = session.files
+
+<tt>files</tt> is an enumerable collection, so you can iterate as you would expect:
+
+    session.files.each do |file|
+      puts file.id
+      puts file.name
+      puts file.size
+    end
+
+
+=== What are all the attributes of a file?
+
+Once you have a file object (e.g. <tt>session.files.first</tt>), the following are the
+primary attributes it exposes:
+
+* id: the unique ID, corresponds to the Mega node handle
+* name: the name of the file
+* size: the size of the file content (in bytes)
+
+
+=== CLI: How to use the command-line client
+
+The gem installation includes a command-line tool. Call it without parameters and it will show help:
+
+    $ megar
+
+All operations require credentials to ba passed on the command line (email and password arguments):
+
+    $ megar --email=my@email.com --password=mypassword
+    Connecting to mega as my@email.com..
+    Connected!
+
+
+=== CLI: How to get a file listing
+
+Use the <tt>ls</tt> command:
+
+    $ megar --email=my@email.com --password=mypassword ls
+    Connecting to mega as my@email.com..
+                  39 bytes  74ZTXbyR    hello_mega.txt
+              137080 bytes  L0xHwayA    mega.png
+
+
+=== How to run tests
+
+Test are implemented using rspec. Run tests with <tt>rake</tt> or <tt>rake spec</tt>.
+
+{Guard}[https://rubygems.org/gems/guard] is installed as part of the development dependencies,
+so to start continuous test execution on file change, start it up with <tt>bundle exec guard</tt>.
+
+
+=== How to refresh unit test expectations
+
+Unit tests make liberal use of expected responses from the actual Mega API.
+In order to enable good unit tests without hitting the Mega API for real,
+test expectations are stored as JSON under 'spec/fixtures/crypto_expectations'.
+
+A rake task is available to re-generate the expectations:
+
+    $ rake gen:crypto_expectations email=my@email.com password=mypassword
+
+    Generating crypto_expectations for my@email.com...
+
+    Done! New crypto_expectations for unit test written to:
+    /.../megar/spec/fixtures/crypto_expectations/sample_user.json
+
+NOTE: the email and password are stored in the expectations file, so be careful not to
+commit and distribute credentials. Change the password on the account first.
+The tests will still run as intended with the snapshot of crypto details stored in the expectations file.
+
+
+== References
+
+* {Mega API is documentation}[https://mega.co.nz/#developers]
+* {Using the Mega API, with Python examples}[http://julien-marchand.fr/blog/using-mega-api-with-python-examples/]
+* {SpiderOak's Analysis and Recommendations for the Crypto in Kim Dotcom's Mega}[https://spideroak.com/blog/20130123130638-spideroaks-analysis-and-recommendations-for-the-crypto-in-kim-dotcoms-mega-part-one]
+
+
+== Contributing
+
+* 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
+* Start a feature/bugfix branch
+* Commit and push until you are happy with your contribution
+* Make sure to add tests for it. This is important so it doesn't get broken in a future version unintentionally.
+* Please try not to mess with the gemspec, 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 it can be cherry-picked around.
+
+== Copyright
+
+Copyright (c) 2013 Paul Gallagher. See LICENSE for further details.

data/Rakefile

@@ -0,0 +1,33 @@
+require "bundler/gem_tasks"
+require 'rspec'
+require 'rspec/core/rake_task'
+
+desc "Run all test examples"
+RSpec::Core::RakeTask.new do |t|
+  t.rspec_opts = ["-c", "-f progress"]
+  t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'rdoc/task'
+RDoc::Task.new do |rdoc|
+  rdoc.main = "README.md"
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "megar"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r megar.rb"
+end
+
+namespace :gen do
+  desc "Generate new unit test expectations given email=your_email password=your_password"
+  task :crypto_expectations do
+    require './spec/spec_helper.rb'
+    include CryptoExpectationsHelper
+    generate_crypto_expectations(ENV['email'], ENV['password'])
+  end
+end

data/bin/megar

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.unshift File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'megar'
+require 'getoptions'
+
+begin
+  options = GetOptions.new(Megar::Shell::OPTIONS)
+  Megar::Shell.new(options,ARGV).run
+rescue Interrupt
+  $stderr.puts "..interrupted."
+rescue Exception => e
+  $stderr.puts "That wasn't meant to happen! #{e.message}"
+  Megar::Shell.usage
+end
+

data/lib/extensions/math.rb

@@ -0,0 +1,13 @@
+
+# Calculate ((b**p) % m) assuming that b and m are large integers.
+# http://blade.nagaokaut.ac.jp/cgi-bin/scat.rb/ruby/ruby-talk/71964
+def Math.powm(b, p, m)
+  if p == 1
+    b % m
+  elsif (p & 0x1) == 0 # p.even?
+    t = powm(b, p >> 1, m)
+    (t * t) % m
+  else
+    (b * powm(b, p-1, m)) % m
+  end
+end

data/lib/js_ref_impl/_README

@@ -0,0 +1,9 @@
+Mega API Javascript Refeence Implementation
+
+The files contained in this folder are not used by the Megar gem.
+
+These are the source Javascript files obtained from mega.co.nz in the course of megar development,
+and are only stored here to provide some traceability when the javascript implementation changes.
+This is only important while the Javascript implementation is the only concrete reference to details
+of the Mega API. It will become redundant when the Mega API is formally lanched with detailed
+documentation.

data/lib/js_ref_impl/base64_1.js

@@ -0,0 +1,83 @@
+
+/* OpenPGP radix-64/base64 string encoding/decoding
+ * Copyright 2005 Herbert Hanewinkel, www.haneWIN.de
+ * version 1.0, check www.haneWIN.de for the latest version
+
+ * This software is provided as-is, without express or implied warranty.  
+ * Permission to use, copy, modify, distribute or sell this software, with or
+ * without fee, for any purpose and by any individual or organization, is hereby
+ * granted, provided that the above copyright notice and this paragraph appear 
+ * in all copies. Distribution as a part of an application or binary must
+ * include the above copyright notice in the documentation and/or other materials
+ * provided with the application or distribution.
+ */
+
+var b64s='ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/'
+
+function s2r(t)
+{
+ var a, c, n;
+ var r='', l=0, s=0;
+ var tl=t.length;
+
+ for(n=0; n<tl; n++)
+ {
+  c=t.charCodeAt(n);
+  if(s == 0)
+  {
+   r+=b64s.charAt((c>>2)&63);
+   a=(c&3)<<4;
+  }
+  else if(s==1)
+  {
+   r+=b64s.charAt((a|(c>>4)&15));
+   a=(c&15)<<2;
+  }
+  else if(s==2)
+  {
+   r+=b64s.charAt(a|((c>>6)&3));
+   l+=1;
+   if((l%60)==0) r+="\n";
+   r+=b64s.charAt(c&63);
+  }
+  l+=1;
+  if((l%60)==0) r+="\n";
+
+  s+=1;
+  if(s==3) s=0;  
+ }
+ if(s>0)
+ {
+  r+=b64s.charAt(a);
+  l+=1;
+  if((l%60)==0) r+="\n";
+  r+='=';
+  l+=1;
+ }
+ if(s==1)
+ {
+  if((l%60)==0) r+="\n";
+  r+='=';
+ }
+
+ return r;
+}
+
+function r2s(t)
+{
+ var c, n;
+ var r='', s=0, a=0;
+ var tl=t.length;
+
+ for(n=0; n<tl; n++)
+ {
+  c=b64s.indexOf(t.charAt(n));
+  if(c >= 0)
+  {
+   if(s) r+=String.fromCharCode(a | (c>>(6-s))&255);
+   s=(s+2)&7;
+   a=(c<<s)&255;
+  }
+ }
+ return r;
+}