dribbble-bucket-sync 0.0.1

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/.rvmrc

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+if ! rvm list | grep -q ruby-1.9.3-p194 ; then
+  rvm install 1.9.3-p194
+fi
+
+rvm 1.9.3-p194@ryantownsend_dribbble_bucket_sync --create
+
+if ! gem list | grep -q bundler ; then
+  gem install --no-ri --no-rdoc bundler
+  bundle install --without production
+fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Ryan Townsend
+
+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,54 @@
+# DribbbleBucketSync
+
+Dribbble doesn't offer a solution to backup or sync your buckets and their containing shots to your computer. This gem solves that.
+
+You can sync to any local directory you wish, a folder will be created for each bucket, and the shots will be downloaded therein.
+
+Upon subsequent syncing, the list of shots in a bucket will be downloaded, any missing shots will be downloaded, and any shots no longer in the bucket will be removed.
+
+## Installation
+
+Note: requires Ruby 1.9
+
+Add this line to your application's Gemfile:
+
+    gem "dribbble-bucket-sync"
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install dribbble-bucket-sync
+
+## Usage
+
+There is a command-line script to access the synchronisation:
+
+    $ dribbble_bucket_sync dribbble_username path/to/dir
+    
+Output should be like this:
+
+    $ dribbble_bucket_sync ryantownsend ~/dribbble
+    Starting synchronisation...
+    ryantownsend has 29 buckets.
+    Timelines has 2 shots.
+    Colour Palettes has 1 shots.
+    Synchronisation complete.
+
+The syntax to run within your own app is fairly straight-forward:
+
+    require "dribbble_bucket_sync"
+    # create a location to store the files
+    directory = File.join(File.dirname(__FILE__), "data")
+    # start the synchronisation
+    DribbbleBucketSync.new("ryantownsend").sync_to(directory)
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/bin/dribbble_bucket_sync

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "dribbble_bucket_sync"
+
+unless ARGV.size == 2
+	raise ArgumentError, "Must have 2 arguments: username and output directory"
+end
+
+username = ARGV[0]
+directory = ARGV[1]
+
+unless File.directory?(directory)
+	raise ArgumentError, "Directory does not exist: #{directory}"
+end
+
+puts "Starting synchronisation..."
+
+# start the synchronisation
+DribbbleBucketSync.new(username).sync_to(directory)
+
+puts "Synchronisation complete."
+
+system("open #{directory}")

data/dribbble_bucket_sync.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/dribbble_bucket_sync/version', __FILE__)
+
+Gem::Specification.new do |s|
+  s.authors       = ["Ryan Townsend"]
+  s.email         = ["ryan@ryantownsend.co.uk"]
+  s.description   = %q{Synchronises your Dribbble buckets with a local folder}
+  s.summary       = s.description
+  s.homepage      = "https://github.com/ryantownsend/dribbble-bucket-sync"
+
+  s.files         = `git ls-files`.split($\)
+  s.executables   = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  s.test_files    = s.files.grep(%r{^(test|spec|features)/})
+  s.name          = "dribbble-bucket-sync"
+  s.require_paths = ["lib"]
+  s.version       = DribbbleBucketSync::VERSION
+  
+  s.add_dependency "dribbble-bucket-api"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "simplecov"
+end

data/lib/dribbble_bucket_sync.rb

@@ -0,0 +1,65 @@
+require "fileutils"
+require "dribbble_bucket_api"
+require "dribbble_bucket_sync/version"
+require "dribbble_bucket_sync/folder"
+
+class DribbbleBucketSync
+	attr_reader :username
+	
+	def initialize(username)
+		@username = username
+	end
+	
+	def sync_to(directory)
+		# ensure the directory exists
+		unless File.directory?(directory)
+			raise ArgumentError, "Sync destination must be a valid directory:\n#{directory}"
+		end
+		# get the first page
+		response = connection.buckets(page: 1)
+		# load the total pages
+		total_pages = response.total_pages
+		# return if total pages is none
+		return if total_pages < 1
+		# print how many buckets there are
+		puts "#{@username} has #{response.total_entries} buckets."
+		# loop through each page
+		1.upto(total_pages) do |page|
+			# load the buckets for this page
+			buckets = connection.buckets(page: page)
+			# sync each bucket
+			buckets.each do |bucket|
+				sync_bucket(bucket, directory)
+			end
+		end
+	end
+	
+	private
+	def sync_bucket(bucket, directory)
+		# create the folder for the bucket
+		folder = Folder.new(directory, bucket.name)
+		# get the first page
+		response = bucket.shots(page: 1)
+		# load the total pages
+		total_pages = response.total_pages
+		# return if total pages is none
+		return if total_pages < 1
+		# print how many shots there are
+		puts "#{bucket.name} has #{response.total_entries} shots."
+		# loop through each page
+		1.upto(total_pages) do |page|
+			# load the buckets for this page
+			shots = bucket.shots(page: page)
+			# add each shot to the folder
+			shots.each do |shot|
+				folder.add_shot(shot)
+			end
+		end
+		# remove old shots
+		folder.remove_old_shots
+	end
+	
+	def connection
+		@connection = DribbbleBucketApi.connect(username: @username)
+	end
+end

data/lib/dribbble_bucket_sync/folder.rb

@@ -0,0 +1,74 @@
+require "fileutils"
+require "uri"
+require "net/http"
+
+class DribbbleBucketSync
+	class Folder
+		attr_reader :path, :shots
+
+		def initialize(directory, name)
+			name = sanitize(name)
+			# store the path
+			@path = File.join(directory, name)
+			# ensure our folder exists
+			ensure_folder_exists
+			# create storage for the shots
+			@shots = []
+		end
+		
+		def add_shot(shot)
+			url = shot.image_url
+			# add the file to the shots list
+			filename = "#{shot.id}#{File.extname(url)}"
+			@shots << filename
+			# calculate the path
+			path = File.join(@path, filename)
+			# download if it doesn't exist
+			unless File.exist?(path)
+				download(url, path)
+			end
+		end
+		
+		def remove_old_shots
+			# loop through all shots in the folder
+			current_shot_files.each do |file|
+				# delete file if the shot isn't in the array
+				unless @shots.include?(File.basename(file))
+					FileUtils.rm(file)
+				end
+			end
+		end
+
+		# returns an array of existing shot files
+		def current_shot_files
+			Dir.glob(File.join(@path, "*.{jpg,jpeg,png,gif}"))
+		end
+		
+		private
+		# downloads a URL to a local path
+		def download(url, destination)
+			# parse the URL
+			uri = URI.parse(url)
+			# connect to the site
+			Net::HTTP.start(uri.host, uri.port) do |http|
+				# download the file
+				resp = http.get(uri.request_uri)
+				# open the local file
+				open(destination, "wb") do |file|
+					# write the data
+					file.write(resp.body)
+				end
+			end
+		end
+		
+		# ensure the folder exists
+		def ensure_folder_exists
+			FileUtils.makedirs(@path)
+		end
+		
+		# sanitizes the folder name
+		def sanitize(name)
+			name.downcase.gsub(/[^\w\-\s]/, "-").gsub(/[\-\_]+/, "-").gsub(/[\-\_]*$|^[\-\_]*/, "")
+		end
+	end
+end

data/lib/dribbble_bucket_sync/version.rb

@@ -0,0 +1,3 @@
+class DribbbleBucketSync
+  VERSION = "0.0.1"
+end

data/spec/dribbble_bucket_sync/folder_spec.rb

@@ -0,0 +1,53 @@
+require "spec_helper"
+require_relative "../../lib/dribbble_bucket_sync/folder"
+
+describe DribbbleBucketSync::Folder do
+	let(:directory) { File.join(File.dirname(__FILE__), "../tmp") }
+	let(:name) { "bucket-name" }
+	
+	subject { DribbbleBucketSync::Folder.new(directory, name) }
+	
+	after(:all) do
+		FileUtils.remove_dir(directory)
+	end
+
+	describe "::new" do
+		let(:name) { "_a;rand0m-bucKet-()$" }
+		
+		it "should sanitize the name" do
+			folder = File.join(directory, "a-rand0m-bucket")
+			expect(subject.path).to eq(folder)
+		end
+		
+		it "should create the folder" do
+			expect(File.directory?(subject.path)).to be_true
+		end
+	end
+	
+	describe "#add_shot" do
+		let(:url) { "http://example.com/file.jpg" }
+		let(:shot) { mock("shot", id: 123456, image_url: url) }
+		let(:destination) { File.join(subject.path, "#{shot.id}.jpg") }
+
+		it "should add the file to the shots" do
+			FileUtils.rm(destination) if File.exist?(destination)
+			subject.should_receive(:download).with(url, destination).and_return(true)
+			subject.add_shot(shot)
+			expect(subject.shots).to include("123456.jpg")
+		end
+	end
+	
+	describe "#remove_old_shots" do
+		let(:old_shot) { File.join(subject.path, "98765.png") }
+
+		before(:each) do
+			FileUtils.touch(old_shot)
+		end
+		
+		it "should delete any shots no longer in the bucket" do
+			expect(File.exist?(old_shot)).to be_true
+			subject.remove_old_shots
+			expect(File.exist?(old_shot)).to be_false
+		end
+	end
+end

data/spec/dribbble_bucket_sync_spec.rb

@@ -0,0 +1,16 @@
+require "spec_helper"
+require "fileutils"
+require_relative "../lib/dribbble_bucket_sync"
+
+describe DribbbleBucketSync do
+	subject { DribbbleBucketSync.new(username) }
+	
+	let(:username) { "ryantownsend" }
+	
+	describe "::new" do
+		it "should accept a username" do
+			expect(subject.username).to eq("ryantownsend")
+		end
+	end
+	
+end

data/spec/spec_helper.rb

@@ -0,0 +1,2 @@
+require "simplecov"
+SimpleCov.start

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: dribbble-bucket-sync
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Ryan Townsend
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: dribbble-bucket-api
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Synchronises your Dribbble buckets with a local folder
+email:
+- ryan@ryantownsend.co.uk
+executables:
+- dribbble_bucket_sync
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- bin/dribbble_bucket_sync
+- dribbble_bucket_sync.gemspec
+- lib/dribbble_bucket_sync.rb
+- lib/dribbble_bucket_sync/folder.rb
+- lib/dribbble_bucket_sync/version.rb
+- spec/dribbble_bucket_sync/folder_spec.rb
+- spec/dribbble_bucket_sync_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/ryantownsend/dribbble-bucket-sync
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Synchronises your Dribbble buckets with a local folder
+test_files:
+- spec/dribbble_bucket_sync/folder_spec.rb
+- spec/dribbble_bucket_sync_spec.rb
+- spec/spec_helper.rb