worochi 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ba19eba17277fa5f087571933bc694748ab1d5bc
-  data.tar.gz: caf94af71f2b4604cdca507712ec0d7021733496
+  metadata.gz: a2a18845c1adcadfe7c424ac39bf2d9d8a66ae5e
+  data.tar.gz: ea90cb0fb85aa177b54226862af3cd56f9b80487
 SHA512:
-  metadata.gz: 53d259f34d1d476bc244e7fe6be7da7f8fe2b9f768795e9b47d58a1d75677e05b9ef4106c415985a959764ca96424fc50fa410bab9a92a78c8b3ccfa78ae2bea
-  data.tar.gz: 5ae4f9391864dd60cf2f3cd00ecdf9238ac3ef5b027f0ed1b2be3eb2dc0fc27686a9739264c8543ce134045c6288f7c1521716b5b401aea39285531d500b552e
+  metadata.gz: dcf3004c8fe46c9ed7df05d05bcea8d312eb0109f4fff883fd54f7640abb0118163b189df4892d0f73196443beb9b52d78780631cb3d98f60e5bd1260d39b2d2
+  data.tar.gz: 227612326f57102371ee6e94a4ffdfd53c50ff063f61440cdd98e050f4cc4c82a0280b3ad6b18a46cc2515a1bb7bbcbfa11745edf8c26191e705612d335a831d

data/README.md

@@ -156,10 +156,6 @@ Tokens are hashes and `refresh` expects a hash containing the field
 
 Currently these services are fully supported:
 
-**Google Drive**
-  - Service name `:google_drive`
-  - Env variables `GOOGLE_ID` `GOOGLE_SECRET` `GOOGLE_TEST_TOKEN`
-
 **Dropbox**
   - Service name `:dropbox`
   - Env variables `DROPBOX_ID` `DROPBOX_SECRET` `DROPBOX_TEST_TOKEN`
@@ -168,6 +164,14 @@ Currently these services are fully supported:
   - Service name `:github`
   - Env variables `GITHUB_ID` `GITHUB_SECRET` `GITHUB_TEST_TOKEN`
 
+**Google Drive**
+  - Service name `:google_drive`
+  - Env variables `GOOGLE_ID` `GOOGLE_SECRET` `GOOGLE_TEST_TOKEN`
+
+**Box**
+  - Service name `:box`
+  - Env variables `BOX_ID` `BOX_SECRET` `BOX_TEST_TOKEN`
+
 ### Environmental Variables
 
 `ID` and `SECRET` variables are only needed for retrieving access tokens and

data/circle.yml

@@ -8,12 +8,13 @@ machine:
     AWS_SECRET_ACCESS_KEY: abc
     BOX_ID: abc
     BOX_SECRET: abc
-    GOOGLE_ID: abc
-    GOOGLE_SECRET: abc
-    GITHUB_ID: abc
-    GITHUB_SECRET: abc
+    BOX_TEST_TOKEN: abc
     DROPBOX_ID: abc
     DROPBOX_SECRET: abc
-    GITHUB_TEST_TOKEN: abc
     DROPBOX_TEST_TOKEN: abc
+    GITHUB_ID: abc
+    GITHUB_SECRET: abc
+    GITHUB_TEST_TOKEN: abc
+    GOOGLE_ID: abc
+    GOOGLE_SECRET: abc
     GOOGLE_TEST_TOKEN: abc

data/lib/worochi/agent.rb

@@ -246,7 +246,6 @@ end
 Worochi::Config.services.each do |service|
   begin
     require "worochi/agent/#{service}"
-  rescue LoadError
-    Worochi::Log.warn "Found #{service}.yml but not #{service}.rb"
+  rescue LoadError # yml is defined but not the agent
   end
 end

data/lib/worochi/agent/#example.rb

@@ -41,7 +41,7 @@ class Worochi
     # @see Agent#folders
     # @see Agent#files
     def list(path=nil)
-      remote_path = path || options[:dir]
+      remote_path = list_path(path)
       result = @client.get_file_list(remote_path)
       result.map do |elem|
         {

data/lib/worochi/agent/box.rb

@@ -0,0 +1,78 @@
+require 'ruby-box'
+
+class Worochi
+  # The {Agent} for Box API.
+  # @see https://github.com/attachmentsme/ruby-box
+  class Agent::Box < Agent
+    # Initializes ruby-box client.
+    #
+    # @return [RubyBox::Client]
+    def init_client
+      session = RubyBox::Session.new(
+        client_id: 'dummy_id',
+        access_token: options[:token])
+      @client = RubyBox::Client.new(session)
+    end
+
+    # Returns a list of files and subdirectories at the remote path specified
+    # by `options[:dir]`.
+    #
+    # @param path [String] path to list instead of the current directory
+    # @return [Array<Hash>] list of files and subdirectories
+    def list(path=nil)
+      remote_path = list_path(path)
+      begin
+        folder = @client.folder(remote_path)
+        raise Error if folder.nil?
+        folder.items.map do |elem|
+          {
+            name: elem.name,
+            path: "#{remote_path}/#{elem.name}",
+            type: elem.type
+          }
+        end
+      rescue RubyBox::AuthError
+        box_error
+      end
+    end
+
+    # Push a single {Item} to Box.
+    #
+    # @param item [Item]
+    def push_item(item)
+      abs_path = full_path(item.path)
+      begin
+        folder = @client.create_folder(File.dirname(abs_path))
+        raise Error if folder.nil?
+        folder.upload_file(item.filename, item.content, true)
+      rescue RubyBox::AuthError
+        box_error
+      end
+      nil
+    end
+
+    # Deletes the file at `path` from Box.
+    #
+    # @param path [String] path relative to current directory
+    # @return [Boolean] `true` if a file was actually deleted
+    def delete(path)
+      abs_path = full_path(path)
+      begin
+        file = @client.file(abs_path)
+        return false if file.nil?
+        file.delete
+      rescue RubyBox::AuthError
+        box_error
+      end
+      true
+    end
+
+  private
+
+    # Box tokens can expire so the user should check for this error to and
+    # refresh the access token when necessary.
+    def box_error
+      raise Error, 'Box access token is valid or has expired'
+    end
+  end
+end

data/lib/worochi/version.rb

@@ -1,4 +1,4 @@
 class Worochi
   # Current version of the gem
-  VERSION = '0.0.17'
+  VERSION = '0.0.18'
 end

data/spec/spec_helper.rb

@@ -29,7 +29,8 @@ end
 test_token_prefix = {
   google_drive: 'GOOGLE',
   dropbox: 'DROPBOX',
-  github: 'GITHUB'
+  github: 'GITHUB',
+  box: 'BOX'
 }
 
 # Removes sensitive keys from recordings
@@ -69,7 +70,7 @@ RSpec.configure do |c|
     if ENV["#{prefix}_TEST_TOKEN"].nil?
       c.filter_run_excluding service
       service_name = Worochi::Config.service_display_name(service)
-      puts "#{prefix}_TEST_TOKEN not found. Skipping Google Drive tests."
+      puts "#{prefix}_TEST_TOKEN not found. Skipping #{service_name} tests."
     end
   end 
-end
+end

data/spec/worochi/agent/box_spec.rb

@@ -0,0 +1,34 @@
+require 'spec_helper'
+
+describe Worochi::Agent::Box, :box do
+  let(:required_keys) { [] }
+  let(:client_class) { RubyBox::Client }
+
+  let(:agent) do
+    Worochi::Agent::Box.new(
+      token: ENV['BOX_TEST_TOKEN'],
+      dir: '/worochi/test')
+  end
+
+  it_should_behave_like 'a service agent'
+
+  describe '#push_item', :vcr do
+    it 'pushes a single item' do
+      item = Worochi::Item.open_single(local.source)
+      agent.push_item(item)
+      expect(agent.files).to include(local.name)
+      agent.delete(local.name)
+      expect(agent.files).not_to include(local.name)
+    end  
+  end
+
+  describe '#box_error', :vcr do
+    it 'raises an error on expired/invalid tokens' do
+      bad_agent = Worochi::Agent::Box.new(token: 'badtoken')
+      expect{bad_agent.files}.to raise_error(Worochi::Error)
+      item = Worochi::Item.open_single(local.source)
+      expect{bad_agent.push_item(item)}.to raise_error(Worochi::Error)
+      expect{bad_agent.delete(local.name)}.to raise_error(Worochi::Error)
+    end
+  end
+end

data/worochi.gemspec

@@ -32,6 +32,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency('dropbox-sdk') # Dropbox
   s.add_runtime_dependency('google-api-client') # Google
   s.add_runtime_dependency('octokit', ['1.25.0']) # GitHub
+  s.add_runtime_dependency('ruby-box') # Box
 
   s.add_development_dependency('ruby-filemagic')
   s.add_development_dependency('rspec', ['~> 2.14.1'])

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: worochi
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Raven Jiang
@@ -108,6 +108,20 @@ dependencies:
     - - '='
       - !ruby/object:Gem::Version
         version: 1.25.0
+- !ruby/object:Gem::Dependency
+  name: ruby-box
+  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: ruby-filemagic
   requirement: !ruby/object:Gem::Requirement
@@ -253,6 +267,7 @@ files:
 - lib/worochi/agent/github.rb
 - lib/worochi/agent/#example.rb
 - lib/worochi/agent/google_drive.rb
+- lib/worochi/agent/box.rb
 - lib/worochi/agent/dropbox.rb
 - lib/worochi/helper.rb
 - lib/worochi/item.rb
@@ -274,6 +289,7 @@ files:
 - spec/worochi/helper/github_helper_spec.rb
 - spec/worochi/agent/dropbox_spec.rb
 - spec/worochi/agent/github_spec.rb
+- spec/worochi/agent/box_spec.rb
 - spec/worochi/agent/google_drive_spec.rb
 - spec/worochi/config_spec.rb
 - spec/worochi/agent_spec.rb
@@ -317,6 +333,7 @@ test_files:
 - spec/worochi/helper/github_helper_spec.rb
 - spec/worochi/agent/dropbox_spec.rb
 - spec/worochi/agent/github_spec.rb
+- spec/worochi/agent/box_spec.rb
 - spec/worochi/agent/google_drive_spec.rb
 - spec/worochi/config_spec.rb
 - spec/worochi/agent_spec.rb