worochi 0.0.0 → 0.0.1

data/spec/worochi/agent/github_spec.rb

@@ -0,0 +1,77 @@
+require 'helper'
+
+describe Worochi::Agent::Github do
+  let(:required_keys) { [:repo, :source, :target, :block_size, :commit_msg] }
+  let(:client_class) { Octokit::Client }
+  let(:master_branch) { 'cdddc3941866854cdb41c023d0f5240ed10df053' }
+
+  let(:agent) do
+    Worochi::Agent::Github.new({
+      token: ENV['GITHUB_TEST_TOKEN'],
+      repo: 'darkmirage/test',
+      source: 'master',
+      target: 'rspec',
+      commit_msg: "RSpec Test"
+    })
+  end
+
+  it_should_behave_like 'a service agent'
+
+  before do
+    @client = agent.init_client
+  end
+
+  describe '#push_all', :vcr do
+    def delete_target
+      tag = "heads/#{agent.options[:target]}"
+      begin
+        @client.delete_ref(agent.options[:repo], tag)
+      rescue Octokit::UnprocessableEntity
+      end
+    end
+
+    it 'pushes a list of items to create a new commit' do
+      @client = agent.init_client
+      delete_target
+
+      hashes = [remote, local].map do |file|
+        { path: file.path, source: file.source }
+      end
+      items = Worochi::Item.open(hashes)
+
+      sha = agent.push_all(items)
+      ref = @client.ref(agent.options[:repo], "heads/#{agent.options[:target]}")
+      expect(ref.object.sha).to eq(sha)
+
+      commit = @client.commit(agent.options[:repo], sha)
+      expect(commit.commit.message).to eq(agent.options[:commit_msg])
+
+      delete_target
+    end
+
+    it 'pushes the file to the right place' do
+      delete_target
+
+      item = Worochi::Item.open({ source: local.source, path: local.path })
+
+      sha = agent.push_all(item)
+      ls = agent.list(File.dirname(local.path), sha).map { |x| x[:name] }
+      expect(ls).to include(local.name)
+      
+      delete_target
+    end
+  end
+
+  describe '#source_branch', :vcr do
+    it 'retrieves the master branch correctly' do
+      expect(agent.send(:source_branch)).to eq(master_branch)
+    end
+  end
+
+  describe '#list', :vcr do
+    it 'works with absolute paths' do
+      ls = agent.list('/folder2/subfolder/test').map { |x| x[:name] }
+      expect(ls).to include('abc.txt')
+    end
+  end
+end

data/spec/worochi/agent_spec.rb

@@ -0,0 +1,2 @@
+require 'helper'
+

data/spec/worochi/helper/github_spec.rb

@@ -0,0 +1,57 @@
+require 'helper'
+
+describe Worochi::Helper::Github do
+  describe Worochi::Helper::Github::StreamIO do
+
+    let(:size) { 114 }
+    let(:stream) do
+      item = Worochi::Item.open_single(local.source)
+      Worochi::Helper::Github::StreamIO.new(item)
+    end
+
+    after do
+      stream.rewind
+    end
+
+    describe '.new' do
+      it 'initializes' do
+        item = Worochi::Item.open_single(local.source)
+        s = Worochi::Helper::Github::StreamIO.new(item)
+        expect(s.class).to be(Worochi::Helper::Github::StreamIO)
+      end
+    end
+
+    describe '#size' do
+      it 'returns the encoded size' do
+        expect(stream.size).to eq(size)
+      end
+    end
+
+    describe '#read' do
+      it 'encodes a file correctly' do
+        checksum = '0bda09766257c6e8d33557cf4d1e1718e82540d46b53d288fc13198e7126f2bc'
+        content = stream.read
+        expect(Digest::SHA2.hexdigest(content)).to eq(checksum)
+        expect(content.size).to eq(size)
+      end
+
+      it 'reads partial lengths' do
+        part = stream.read(6)
+        expect(part).to eq('{"cont')
+        expect(part.size).to eq(6)
+
+        part = stream.read(15)
+        expect(part).to eq('ent":"VGhpcyBpc')
+        expect(part.size).to eq(15)
+      end
+    end
+
+    describe '#rewind' do
+      it 'rewinds the stream' do
+        expect(stream.read(20)).to eq('{"content":"VGhpcyBp')
+        stream.rewind
+        expect(stream.read(20)).to eq('{"content":"VGhpcyBp')
+      end
+    end
+  end
+end

data/spec/worochi/helper_spec.rb

@@ -0,0 +1,23 @@
+require 'helper'
+
+describe Worochi::Helper do
+
+  describe '.is_s3_path?', :aws do
+    it 'recognizes an S3 path' do
+      expect(Worochi::Helper.is_s3_path?('s3:test/path')).to be_true
+    end
+
+    it 'rejects other paths' do
+      expect(Worochi::Helper.is_s3_path?('test/path')).to be_false
+      expect(Worochi::Helper.is_s3_path?('s3/test/path')).to be_false
+      expect(Worochi::Helper.is_s3_path?('http://a.com/path')).to be_false
+    end
+  end
+
+  describe '.s3_url', :aws  do
+    it 'returns the right S3 URL' do
+      url = Worochi::Helper.s3_url('s3:test/path')
+      expect(url.to_s).to match(/^https.+s3\.amazonaws\.com\/test\/path.*/)
+    end
+  end
+end

data/spec/worochi/item_spec.rb

@@ -0,0 +1,85 @@
+require 'helper'
+
+describe Worochi::Item do
+  describe '.open', :vcr do
+
+    def single_file(file, hash=nil)
+      items = Worochi::Item.open(hash || file.source)
+      checksum = Digest::SHA2.hexdigest(items.first.content.read)
+      expect(items.first.class).to be(Worochi::Item)
+      expect(checksum).to eq(file.checksum)
+      expect(items.first.path).to eq(hash ? hash[:path] : file.name)
+    end
+
+    context 'opens a single file' do
+      it 'with String parameter' do
+        single_file(remote)
+        single_file(local)
+      end
+      it 'with Hash parameter' do
+        single_file(remote, { path: remote.path, source: remote.source })
+        single_file(local, { path: local.path, source: local.source })
+      end
+    end
+
+    context 'opens multiple files' do
+      it 'with String parameters' do
+        items = Worochi::Item.open([remote.source, local.source])
+        checksum = Digest::SHA2.hexdigest(items.last.content.read)
+        expect(checksum).to eq(local.checksum)
+        expect(items.size).to eq(2)
+      end
+      it 'with Hash parameters' do
+        hashes = [remote, local, remote, local].map do |file|
+          { path: file.path, source: file.source }
+        end
+        items = Worochi::Item.open(hashes)
+        checksum = Digest::SHA2.hexdigest(items.last.content.read)
+        expect(checksum).to eq(local.checksum)
+        expect(items.size).to eq(4)
+      end
+    end
+  end
+
+  describe '.open_single', :vcr do
+    it 'accepts a String' do
+      item = Worochi::Item.open_single(remote.source)
+      expect(item.class).to be(Worochi::Item)
+      expect(item.size).to eq(remote.size)
+    end
+
+    it 'accepts a Hash' do
+      hash = { path: local.path, source: local.source }
+      item = Worochi::Item.open_single(hash)
+      expect(item.class).to be(Worochi::Item)
+      expect(item.size).to eq(local.size)
+    end
+
+    it 'works with AWS S3 paths', :aws do
+      item = Worochi::Item.open_single(s3.source)
+      expect(item.class).to be(Worochi::Item)
+      checksum = Digest::SHA2.hexdigest(item.content.read)
+      expect(checksum).to eq(s3.checksum)
+    end
+  end
+
+  describe '#read' do
+    it 'reads the content' do
+      item = Worochi::Item.open_single(local.source)
+      first_word = item.read(4)
+      expect(first_word).to eq('This')
+      rest = item.read
+      expect(rest.size).to eq(local.size - 4)
+    end
+  end
+
+  describe '#rewind' do
+    it 'rewinds the content' do
+      item = Worochi::Item.open_single(local.source)
+      item.read
+      expect(item.read.size).to eq(0)
+      expect(item.rewind).to eq(0)
+      expect(item.read.size).to eq(local.size)
+    end
+  end
+end

data/spec/worochi_spec.rb

@@ -0,0 +1,109 @@
+require 'helper'
+
+describe Worochi do
+  let(:token) { 'service token' }
+  def create_dropbox_agent
+    Worochi.create(:dropbox, token)
+  end
+
+  def create_github_agent
+    Worochi.create(:github, token)
+  end
+
+  before do
+    Worochi.reset
+  end
+
+  describe '.size' do
+    it 'returns the number of active agents' do
+      expect(Worochi.size).to eq(Worochi.agents.size)
+    end
+  end
+
+  describe '.list' do
+    it 'returns the right agent names' do
+      a = create_dropbox_agent
+      expect(Worochi.list(false)).to include("0")
+      expect(Worochi.list(false)).to include("Dropbox")
+      b = create_github_agent
+      lines = Worochi.list(false).split("\n")
+      expect(lines.first).to include("Dropbox")
+      expect(lines.last).to include("1")
+      expect(lines.last).to include("GitHub")
+    end
+  end
+
+  describe '.create' do
+    it 'creates a single agent' do
+      a = Worochi.create(:github, token)
+      expect(a.kind_of?(Worochi::Agent)).to be_true
+      expect(Worochi.size).to eq(1)
+    end
+
+    it 'creates four agents' do
+      4.times do
+        a = Worochi.create(:dropbox, token)
+        expect(a.kind_of?(Worochi::Agent)).to be_true
+      end
+      expect(Worochi.size).to eq(4)
+    end
+
+    it 'requires service and token' do
+      expect { Worochi.create }.to raise_error(ArgumentError)
+      expect { Worochi.create(:dropbox) }.to raise_error(ArgumentError)
+    end
+  end
+
+  describe '.reset' do
+    it "removes all agents" do
+      5.times { create_github_agent }
+      expect(Worochi.size).to eq(5)
+      Worochi.reset
+      expect(Worochi.size).to eq(0)
+    end
+  end
+
+  describe '.remove_service' do
+    it 'removes multiple agents by service' do
+      create_dropbox_agent
+      create_github_agent
+      create_dropbox_agent
+      create_github_agent
+      expect(Worochi.size).to eq(4)
+      Worochi.remove_service(:dropbox)
+      create_dropbox_agent
+      expect(Worochi.size).to eq(3)
+      Worochi.remove_service(:github)
+      expect(Worochi.size).to eq(1)
+    end
+
+    it 'removes all agents' do
+      4.times { create_dropbox_agent }
+      4.times { create_github_agent }
+      expect(Worochi.size).to eq(8)
+      Worochi.remove_service
+      expect(Worochi.size).to eq(0)
+    end
+  end
+
+  describe '.agents' do
+    it 'returns a list of active agents' do
+      a = create_dropbox_agent
+      b = create_dropbox_agent
+      expect(Worochi.agents).to include(a, b)
+      expect(Worochi.agents.size).to eq(2)
+    end
+  end
+
+  describe '.add' do
+    it 'adds an agent to the list of active agents' do
+      a = create_dropbox_agent
+      4.times { create_dropbox_agent }
+      expect(Worochi.agents).to include(a)
+      Worochi.reset
+      expect(Worochi.agents).not_to include(a)
+      Worochi.add(a)
+      expect(Worochi.agents).to include(a)
+    end
+  end
+end

data/worochi.gemspec

@@ -1,14 +1,37 @@
+lib = File.expand_path('../lib/', __FILE__)
+$:.unshift lib unless $:.include?(lib)
+
+require 'worochi/version'
+
 Gem::Specification.new do |s|
   s.name = 'worochi'
-  s.version = '0.0.0'
+  s.version = Worochi::VERSION
   s.date = '2013-08-02'
   s.summary = 'Worochi'
   s.description = 'Provides a standard way to interface with Ruby API wrappers provided by various cloud storage services such as Dropbox and Google Drive.'
+
   s.authors = ['Raven Jiang']
   s.email = ['raven@cs.stanford.edu']
-  s.files = %w(README.md worochi.gemspec)
-  s.files += Dir.glob('lib/**/*.rb')
-  s.require_paths = ["lib"]
   s.homepage = 'http://rubygems.org/gems/worochi'
   s.license = 'MIT'
+
+  s.files = %w(README.md LICENSE worochi.gemspec)
+  s.files += Dir.glob('lib/**/*.rb')
+  s.test_files = Dir.glob('spec/**/*')
+
+  s.require_paths = ['lib']
+
+  s.add_runtime_dependency('aws-sdk')
+  s.add_runtime_dependency('dropbox-sdk') # Dropbox
+  s.add_runtime_dependency('octokit') # GitHub
+
+  s.add_development_dependency('rspec', ['~> 2.14.1'])
+  s.add_development_dependency('vcr', ['~> 2.5.0'])
+  s.add_development_dependency('webmock', ['~> 1.9.3'])
+  s.add_development_dependency('awesome_print')
+  s.add_development_dependency('yard')
+
+  s.post_install_message = <<-MESSAGE
+RAWRRRRR!!!
+  MESSAGE
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worochi
 version: !ruby/object:Gem::Version
-  version: 0.0.0
+  version: 0.0.1
 platform: ruby
 authors:
 - Raven Jiang
@@ -9,7 +9,119 @@ autorequire:
 bindir: bin
 cert_chain: []
 date: 2013-08-02 00:00:00.000000000 Z
-dependencies: []
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: aws-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dropbox-sdk
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.14.1
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 2.5.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.9.3
+- !ruby/object:Gem::Dependency
+  name: awesome_print
+  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: yard
+  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'
 description: Provides a standard way to interface with Ruby API wrappers provided
   by various cloud storage services such as Dropbox and Google Drive.
 email:
@@ -19,6 +131,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - README.md
+- LICENSE
 - worochi.gemspec
 - lib/worochi/error.rb
 - lib/worochi/log.rb
@@ -30,12 +143,51 @@ files:
 - lib/worochi/agent/dropbox.rb
 - lib/worochi/helper.rb
 - lib/worochi/item.rb
+- lib/worochi/version.rb
 - lib/worochi.rb
+- spec/worochi/helper_spec.rb
+- spec/worochi/item_spec.rb
+- spec/worochi/helper/github_spec.rb
+- spec/worochi/agent/dropbox_spec.rb
+- spec/worochi/agent/github_spec.rb
+- spec/worochi/agent_spec.rb
+- spec/worochi_spec.rb
+- spec/support/aws_uri_matcher.rb
+- spec/support/shared_exampes_for_agents.rb
+- spec/support/test_files.rb
+- spec/support/test_file
+- spec/cassettes/Worochi_Agent_Dropbox/_push_item_chunked/pushes_a_single_item_in_chunks.yml
+- spec/cassettes/Worochi_Agent_Dropbox/_list/works_with_absolute_paths.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_files/contains_file1.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_files/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_files/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_folders/contains_folder1.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_folders/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_folders/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/_push_item/pushes_a_single_item.yml
+- spec/cassettes/Worochi_Agent_Github/_push_all/pushes_the_file_to_the_right_place.yml
+- spec/cassettes/Worochi_Agent_Github/_push_all/pushes_a_list_of_items_to_create_a_new_commit.yml
+- spec/cassettes/Worochi_Agent_Github/_list/works_with_absolute_paths.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_files/contains_file1.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_files/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_files/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_folders/contains_folder1.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_folders/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_folders/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Github/_source_branch/retrieves_the_master_branch_correctly.yml
+- spec/cassettes/Worochi_Item/_open_single/accepts_a_String.yml
+- spec/cassettes/Worochi_Item/_open_single/works_with_AWS_S3_paths.yml
+- spec/cassettes/Worochi_Item/_open/opens_multiple_files/with_String_parameters.yml
+- spec/cassettes/Worochi_Item/_open/opens_multiple_files/with_Hash_parameters.yml
+- spec/cassettes/Worochi_Item/_open/opens_a_single_file/with_String_parameter.yml
+- spec/cassettes/Worochi_Item/_open/opens_a_single_file/with_Hash_parameter.yml
+- spec/helper.rb
 homepage: http://rubygems.org/gems/worochi
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message: |
+  RAWRRRRR!!!
 rdoc_options: []
 require_paths:
 - lib
@@ -55,5 +207,42 @@ rubygems_version: 2.0.6
 signing_key: 
 specification_version: 4
 summary: Worochi
-test_files: []
+test_files:
+- spec/worochi/helper_spec.rb
+- spec/worochi/item_spec.rb
+- spec/worochi/helper/github_spec.rb
+- spec/worochi/agent/dropbox_spec.rb
+- spec/worochi/agent/github_spec.rb
+- spec/worochi/agent_spec.rb
+- spec/worochi_spec.rb
+- spec/support/aws_uri_matcher.rb
+- spec/support/shared_exampes_for_agents.rb
+- spec/support/test_files.rb
+- spec/support/test_file
+- spec/cassettes/Worochi_Agent_Dropbox/_push_item_chunked/pushes_a_single_item_in_chunks.yml
+- spec/cassettes/Worochi_Agent_Dropbox/_list/works_with_absolute_paths.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_files/contains_file1.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_files/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_files/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_folders/contains_folder1.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_folders/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/it_should_behave_like_a_service_agent/_folders/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Dropbox/_push_item/pushes_a_single_item.yml
+- spec/cassettes/Worochi_Agent_Github/_push_all/pushes_the_file_to_the_right_place.yml
+- spec/cassettes/Worochi_Agent_Github/_push_all/pushes_a_list_of_items_to_create_a_new_commit.yml
+- spec/cassettes/Worochi_Agent_Github/_list/works_with_absolute_paths.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_files/contains_file1.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_files/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_files/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_folders/contains_folder1.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_folders/accepts_a_different_path.yml
+- spec/cassettes/Worochi_Agent_Github/it_should_behave_like_a_service_agent/_folders/accepts_a_different_relative_path.yml
+- spec/cassettes/Worochi_Agent_Github/_source_branch/retrieves_the_master_branch_correctly.yml
+- spec/cassettes/Worochi_Item/_open_single/accepts_a_String.yml
+- spec/cassettes/Worochi_Item/_open_single/works_with_AWS_S3_paths.yml
+- spec/cassettes/Worochi_Item/_open/opens_multiple_files/with_String_parameters.yml
+- spec/cassettes/Worochi_Item/_open/opens_multiple_files/with_Hash_parameters.yml
+- spec/cassettes/Worochi_Item/_open/opens_a_single_file/with_String_parameter.yml
+- spec/cassettes/Worochi_Item/_open/opens_a_single_file/with_Hash_parameter.yml
+- spec/helper.rb
 has_rdoc: