dropscreen 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a6ff227d7feac29321e3e3e1457b585ff4791622
+  data.tar.gz: 8060fa6bb984ccf9528e928457a9c1a258c68538
+SHA512:
+  metadata.gz: e8c8471e4dde06177aba33bd8ffe1ec94e1fa4b129b5442b2dede548f4b3b6fd0ae4da623dc000d340e7820542c7b44d91a1271ec37c64d9ba756f2ca97aeb26
+  data.tar.gz: 784ad40fc8bf3c3b80c91e9dfca192ccb66fad31ce35ed550457c62c59f4f46864fdececff285b8f1ac77d944ea53c84a24abf6b04f252916205bef717ac76f7

data/.gitignore

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

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,27 @@
+Copyright (c) 2014, BSkyB
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this
+  list of conditions and the following disclaimer.
+
+* Redistributions in binary form must reproduce the above copyright notice,
+  this list of conditions and the following disclaimer in the documentation
+  and/or other materials provided with the distribution.
+
+* Neither the name of the {organization} nor the names of its
+  contributors may be used to endorse or promote products derived from
+  this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Sky Haiku Team
+
+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.md

@@ -0,0 +1,64 @@
+# Dropscreen
+
+A gem to sync screenshot files with Dropbox
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'dropscreen'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dropscreen
+
+
+## Authentication
+
+You need to setup an app in dropbox and get a dropbox access token. Instructions are here:
+https://www.dropbox.com/developers/core/start/ruby
+
+## Usage
+
+export the dropbox access token as an environment variable:
+export DROPBOX_ACCESS_TOKEN=**insert dropbox access token here**
+
+### In your code
+require 'dropscreen'
+
+This uses the token from the environment variable and sets the root dir local and remote to be the local app dir and the permitted dropbox dir respectively.
+dropscreen_client = Dropscreen::Client.new
+
+Alternatively, you can pass in a hash with one or more of these options:
+
+client = Dropscreen::Client.new(
+  remote_base_dir: 'remote_base_dir',
+  local_base_dir: 'local_base_dir'
+)
+
+#### Pulling files from dropbox
+   
+client.pull('some_folder'[, 'dest_folder'])
+
+The destination folder will by default be the same name as the source folder, alternatively you can pass in a destination folder as the second param.
+
+
+#### Pushing files to dropbox
+
+client.push('some_folder'[, 'dest_folder'])
+
+The destination folder will by default be the same name as the source folder, alternatively you can pass in a destination folder as the second param.
+
+
+
+## Contributing
+
+1. Fork it ( http://github.com/<my-github-username>/dropscreen/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/dropscreen.gemspec

@@ -0,0 +1,26 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'dropscreen/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "dropscreen"
+  spec.version       = Dropscreen::VERSION
+  spec.authors       = ["Sky Haiku Team"]
+  spec.email         = ["skyhaikuteam@gmail.com"]
+  spec.summary       = %q{Push and pull files to dropbox}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "dropbox-sdk"
+
+  spec.add_development_dependency "bundler", "~> 1.5"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "pry"
+end

data/lib/dropscreen/version.rb

@@ -0,0 +1,3 @@
+module Dropscreen
+  VERSION = "0.0.1"
+end

data/lib/dropscreen.rb

@@ -0,0 +1,51 @@
+require "dropscreen/version"
+require "dropbox_sdk"
+
+module Dropscreen
+  class Client
+
+    attr_accessor :client
+
+    def initialize opts
+      @token = ENV['DROPBOX_ACCESS_TOKEN']
+      @remote_base_dir = opts[:remote_base_dir] || '/'
+      @local_base_dir = opts[:local_base_dir] || '/'
+      @client = DropboxClient.new @token
+    end
+
+    def push(src, dest=src)
+      @client.file_create_folder(File.join(@remote_base_dir, dest)) unless exists? dest
+       Dir.foreach(File.join(@local_base_dir, src)) do |filename|
+         next if filename == '.' or filename == '..' or filename == '.DS_Store'
+         file = open(File.join(@local_base_dir, src, filename))
+         dropbox_file_name = File.basename(filename)
+         @client.put_file(File.join(@remote_base_dir, dest, dropbox_file_name), file, true)
+       end
+    end
+
+    def exists? path
+      fullpath = File.join(@remote_base_dir,path)
+      @client.metadata(fullpath)
+      return true
+    rescue DropboxError => e
+      if e.message.include? 'not found'
+        return false
+      else
+        raise e
+      end
+    end
+
+    def pull(src, dest=src)
+      dest = File.join(@local_base_dir, dest)
+      FileUtils.mkdir_p(dest) unless File.exists?(dest)
+      files = @client.metadata(File.join(@remote_base_dir, src))['contents']
+      files.each do |file|
+        basename = File.basename(file['path'])
+        destination_filename = File.join(dest, basename)
+        contents = @client.get_file(file['path'])
+        open(destination_filename, 'wb') {|f| f.puts contents }
+      end 
+    end
+
+  end
+end

data/spec/dropscreen_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+require 'pry'
+require 'dropbox_sdk'
+
+describe Dropscreen do
+
+  describe Dropscreen::Client do
+
+    before do
+      `rm -rf artifacts/reference_screenshots` 
+      @client = Dropscreen::Client.new(
+        remote_base_dir: 'dropscreen',
+        local_base_dir: 'artifacts'
+       )
+    end
+
+    describe '#pull' do
+
+        it 'should pull down all the files in a given directory' do
+          @client.pull('reference_screenshots')
+          File.exists?('artifacts/reference_screenshots/advisor_page_firefox.gif').should be_true  
+          File.exists?('artifacts/reference_screenshots/advisor_page_ie9.gif').should be_true  
+        end
+
+    end
+
+    describe '#exists?' do
+      it 'should be false if it doesnt exist' do
+        @client.exists?('flibble').should be_false
+      end
+      it 'should be true if it exists' do
+        @client.exists?('reference_screenshots').should be_true
+      end
+    end
+
+
+    describe '#push' do
+      
+      it 'should create the destination folder if it doesnt already exist' do
+        @client.push('screenshots_generated_this_run')
+        new_folder = @client.client.metadata('dropscreen/screenshots_generated_this_run/')
+        fail "Folder wasn't created" unless new_folder['is_dir']
+      end
+
+      it 'should not create the destination folder if it already exists' do
+        @client.push('screenshots_generated_this_run')
+        @client.push('screenshots_generated_this_run')
+      end
+
+
+      it 'should push up all the files in a given directory' do
+        @client.push('screenshots_generated_this_run')
+        contents = @client.client.metadata('dropscreen/screenshots_generated_this_run/')['contents']
+      end
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'dropscreen'
+
+
+RSpec.configure do |config|
+
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: dropscreen
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Sky Haiku Team
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-16 00:00:00.000000000 Z
+dependencies:
+- !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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  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: rspec
+  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: pry
+  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: 
+email:
+- skyhaikuteam@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE
+- LICENSE.txt
+- README.md
+- Rakefile
+- artifacts/screenshots_generated_this_run/advisor_page_firefox.gif
+- artifacts/screenshots_generated_this_run/advisor_page_ie9.gif
+- dropscreen.gemspec
+- lib/dropscreen.rb
+- lib/dropscreen/version.rb
+- spec/dropscreen_spec.rb
+- spec/spec_helper.rb
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.0
+signing_key: 
+specification_version: 4
+summary: Push and pull files to dropbox
+test_files:
+- spec/dropscreen_spec.rb
+- spec/spec_helper.rb