dotfiles 1.0.0

data/bin/dotfiles

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'dot_files'
+
+DotFiles::Dispatch.load_commands
+DotFiles::Dispatch.run(ARGV.shift, ARGV)

data/lib/dot_files.rb

@@ -0,0 +1,32 @@
+require 'rubygems'
+require 'json'
+require 'uri'
+require 'net/http'
+require 'digest'
+
+require 'dot_files/errors'
+require 'dot_files/config'
+require 'dot_files/dsl'
+require 'dot_files/dispatch'
+require 'dot_files/command'
+
+module DotFiles
+  VERSION = '1.0'
+  
+  class << self
+    
+    ## Return a configuration object for configuring access to the gem
+    def config
+      @config ||= Config.new
+    end
+    
+    def site
+      "http://localhost:3000"
+    end
+    
+    def configuration_path
+      File.join(ENV['HOME'], '.dotfiles')
+    end
+    
+  end
+end

data/lib/dot_files/command.rb

@@ -0,0 +1,125 @@
+module DotFiles
+  class Command
+    
+    def initialize(block)
+      (class << self;self end).send :define_method, :command, &block
+    end
+    
+    def call(*args)
+      arity = method(:command).arity
+      args << nil while args.size < arity
+      send :command, *args
+    end
+    
+    def error(message, exit_code = 1)
+      puts "\e[31m#{message}\e[0m"
+      Process.exit(exit_code)
+    end
+    
+    def request(path, options = {})
+      uri = URI.parse(DotFiles.site + "/" + path)
+      
+      if options[:data]
+        req = Net::HTTP::Post.new(uri.path)
+      else
+        req = Net::HTTP::Get.new(uri.path)
+      end
+      
+      
+      req.basic_auth(options[:username] || DotFiles.config.username, options[:api_key] || DotFiles.config.api_key)
+      
+      res = Net::HTTP.new(uri.host, uri.port)
+      
+      req.add_field("Accept", "application/json")
+      req.add_field("Content-type", "application/json")
+      
+      if options[:data]
+        options[:data] = options[:data].to_json
+      end
+      
+      #res.use_ssl = true
+      #res.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      begin
+        Timeout.timeout(10) do
+          res = res.request(req, options[:data])
+          case res
+          when Net::HTTPSuccess
+            return res.body.strip
+          else
+            false
+          end
+        end
+      rescue Timeout::Error
+        puts "Sorry, the request timed out. Please try again later."
+        Process.exit(1)
+      end
+    end
+    
+    def require_setup
+      unless DotFiles.config.username && DotFiles.config.api_key
+        error "You haven't configured this computer yet. Run 'dotfiles setup' to authorise this computer."
+      end
+    end
+    
+    
+    ## Return an array of all files which need to be synced
+    def remote_files
+      if files = get_remote_files
+        array = []
+        for filename, remote_sha in files
+          hash = {:filename => filename, :action => nil, :local_sha => nil, :local_cached_sha => nil, :remote_sha => remote_sha, :local_path => File.join(ENV['HOME'], filename)}
+          
+          if File.exist?(hash[:local_path])
+            hash[:local_sha] = Digest::SHA1.hexdigest(File.read(hash[:local_path]))
+            hash[:local_cached_sha] = DotFiles.config.shas[hash[:filename]]
+            
+            local_file_changed = (hash[:local_sha] != hash[:local_cached_sha])
+            remote_file_changed = (hash[:local_cached_sha] != hash[:remote_sha])
+            
+            if local_file_changed && remote_file_changed
+              hash[:action] = :conflict
+            elsif !local_file_changed && remote_file_changed
+              hash[:action] = :update_local
+            elsif local_file_changed && !remote_file_changed
+              hash[:action] = :update_remote
+            else
+              hash[:action] = :none
+            end
+          else
+            hash[:action] = :create_local
+          end
+          
+          array << hash
+        end
+        array
+      else
+        error "We couldn't get a list of files from the remote service. Please try later."
+      end
+    end
+    
+    def puts(text = '')
+      text = text.to_s
+      text.gsub!(/\{\{(.*)\}\}/) { "\e[33m#{$1}\e[0m"}
+      super
+    end
+    
+    def remote_file_contents(path)
+      req = request("#{DotFiles.config.username}/#{path}")
+      req ? JSON.parse(req)['file'] : nil
+    end
+    
+    def save_remote_file(path, contents)
+      req = request("save", :data => {:dot_file => {:path => path, :file => contents}})
+      req ? true : false
+    end
+
+    private
+
+    def get_remote_files
+      req = request("files_list")
+      req ? JSON.parse(req) : nil
+    end
+
+    
+  end
+end

data/lib/dot_files/commands/files.rb

@@ -0,0 +1,89 @@
+desc 'Display a list of all files which are registered for syncing'
+usage 'files'
+command :status do
+  require_setup
+  
+  files = remote_files.select{|f| f[:action] != :none }
+  puts
+  if files.empty?
+    puts " No changes are required at this time. You can make changes to your remote or"
+    puts " local files and and rerun {{dotfiles status}} to see how changes will be applied"
+    puts " on your computer."
+  else
+    puts " The following changes need to be made to your local files to bring them inline"
+    puts " with the remote system. Run {{dotfiles sync}} to carry out these changes."
+    puts
+    puts " You can login at http://mydotfiles.com to make changes to your files or use"
+    puts " the {{dotfiles add path/to/file}} command to upload a new file to your your"
+    puts " remote MyDotFiles account."
+    puts
+    for info in files
+      puts "     #{info[:action].to_s.gsub('_', ' ').rjust(15)}:   #{info[:filename]}"
+    end
+  end
+  puts
+end
+
+desc 'Sync changes between local and remote machines'
+usage 'sync'
+command :sync do
+  require_setup
+  
+  DotFiles.config.shas = Hash.new unless DotFiles.config.shas.is_a?(Hash)
+  
+  files = remote_files
+  if files.all?{|f| f[:action] == :none}
+    error "No changes required at this time."
+  else
+    for file in files.select{|f| f[:action] != :none}
+      case file[:action]
+      when :create_local, :update_local
+        puts "{{downloading}} #{file[:filename]}"
+        contents = remote_file_contents(file[:filename])
+        puts "{{saving}} #{file[:filename]}"
+        local_path = File.join(ENV['HOME'], file[:filename])
+        File.open(local_path, 'w') { |f| f.write(contents) }
+        puts "{{saved}} #{contents.size.to_s} bytes to #{local_path}"
+        DotFiles.config.shas[file[:filename]] = Digest::SHA1.hexdigest(contents)
+      when :update_remote
+        puts "{{uploading}} #{file[:filename]}"
+        local_path = File.join(ENV['HOME'], file[:filename])
+        contents = File.read(local_path)
+        save_remote_file(file[:filename], contents)
+        puts "{{uploaded}} #{contents.size.to_s} bytes to #{file[:filename]}"
+        DotFiles.config.shas[file[:filename]] = Digest::SHA1.hexdigest(contents)
+      else
+        puts "nothing to do with #{file[:filename]}"
+      end
+    end
+    
+    DotFiles.config.last_sync_at = Time.now.utc
+    DotFiles.config.save
+    
+  end
+end
+
+desc 'Add a new (or overwrite an existing) file'
+usage 'add path/to/dotfile'
+command :add do |path|
+  filename = path.gsub(/\A#{ENV['HOME']}\//, '')
+  local_path = File.join(ENV['HOME'], filename)
+  contents = File.read(local_path)
+  save_remote_file(filename, contents)
+  DotFiles.config.shas[filename] = Digest::SHA1.hexdigest(contents)
+  DotFiles.config.save
+  puts "#{filename} added to remote successfully"
+end
+
+desc 'Pull a remote file to your local file system'
+usage 'pull path/to/dotfile'
+command :pull do |path|
+  filename = path.gsub(/\A#{ENV['HOME']}\//, '')
+  local_path = File.join(ENV['HOME'], filename)
+  if contents = remote_file_contents(filename)
+    File.open(local_path, 'w') { |f| f.write(contents) }
+    puts "Downloaded #{contents.size} bytes to #{local_path}."
+  else
+    error "Couldn't download remote file from '#{filename}'. Does it exist?"
+  end
+end

data/lib/dot_files/commands/help.rb

@@ -0,0 +1,5 @@
+desc 'Get Help'
+usage 'help'
+command :help do
+  puts "This is help!"
+end

data/lib/dot_files/commands/setup.rb

@@ -0,0 +1,32 @@
+desc 'Authorise/setup this computer with access to your DotFiles account'
+usage 'setup'
+command :setup do
+  
+  require 'highline/import'
+  HighLine.track_eof = false
+
+  
+  puts "Welcome to MyDotFiles."
+  puts
+  puts "To begin, we need you to enter your login details so we can authorise"
+  puts "this computer to sync dot files from your mydotfiles.com account:"
+  puts
+  
+  username = ask("Username: ")
+  password = ask("Password: ") { |q| q.echo = ''}
+  
+  puts
+  puts "Attempting to authenticate you as #{username}..."
+  
+  url = "https://#{DotFiles.site}/apikey"
+  api_key = request("apikey", :username => username, :api_key => password)
+  
+  if api_key
+    DotFiles.config.username = username
+    DotFiles.config.api_key = api_key
+    DotFiles.config.save
+    puts "\e[32mThis computer has now been authorised. Run 'dotfiles sync' to get the latest files.\e[0m"
+  else
+    error "Your account could not be authorised. Please check your email address & password."
+  end
+end

data/lib/dot_files/config.rb

@@ -0,0 +1,40 @@
+module DotFiles
+  class Config
+    
+    attr_reader :path, :configuration
+    
+    def initialize(path = DotFiles.configuration_path)
+      @path = path
+      if File.exist?(path)
+        file_data = File.read(path)
+        @configuration = (file_data.nil? || file_data.length == 0 ? {} : YAML::load(file_data))
+      else
+        @configuration = Hash.new
+      end
+    end
+    
+    def get(key)
+      configuration[key.to_sym]
+    end
+    
+    def set(key, value)
+      configuration[key.to_sym] = value
+      save
+      value
+    end
+    
+    def method_missing(method_name, value = nil)
+      method_name = method_name.to_s
+      if method_name[-1,1] == '='
+        set(method_name.gsub(/\=\z/, ''), value)
+      else
+        get(method_name)
+      end
+    end
+    
+    def save
+      File.open(path, 'w') { |f| f.write(YAML::dump(@configuration)) }
+    end
+    
+  end
+end

data/lib/dot_files/dispatch.rb

@@ -0,0 +1,33 @@
+module DotFiles
+  module Dispatch
+    class << self
+    
+      def run(command, args = [])
+        command = 'help' if command.nil?
+        command = command.to_sym
+        if DotFiles::DSL.commands[command]
+          if args.size < DotFiles::DSL.commands[command][:required_args]
+            puts "usage: #{DotFiles::DSL.commands[command][:usage]}"
+          else
+            DotFiles::DSL.commands[command][:block].call(*args)
+          end
+        else
+          puts "Command not found. Check 'deploy help' for full information."
+        end
+      rescue DotFiles::Errors::AccessDenied
+        puts "Access Denied. The username & API key stored for your account was invalid. Have you run 'dotfiles setup' on this computer?"
+        Process.exit(1)
+      rescue DotFiles::Error
+        puts "An error occured with your request."
+        Process.exit(1)
+      end
+      
+      def load_commands
+        Dir[File.join(File.dirname(__FILE__), 'commands', '*.rb')].each do |path|
+          DotFiles::DSL.module_eval File.read(path), path
+        end
+      end
+            
+    end
+  end
+end

data/lib/dot_files/dsl.rb

@@ -0,0 +1,35 @@
+module DotFiles
+  module DSL
+    
+    extend self
+
+    def command(command, options = {}, &block)
+      @commands = Hash.new if @commands.nil?
+      @commands[command] = Hash.new
+      @commands[command][:description] = @next_description
+      @commands[command][:usage] = @next_usage
+      @commands[command][:flags] = @next_flags
+      @commands[command][:required_args] = (options[:required_args] || 0)
+      @commands[command][:block] = Command.new(block)
+      @next_usage, @next_description, @next_flags = nil, nil, nil
+    end
+    
+    def commands
+      @commands || Hash.new
+    end
+    
+    def desc(value)
+      @next_description = value
+    end
+    
+    def usage(value)
+      @next_usage = value
+    end
+    
+    def flag(key, value)
+      @next_flags = Hash.new if @next_flags.nil?
+      @next_flags[key] = value
+    end 
+
+  end
+end

data/lib/dot_files/errors.rb

@@ -0,0 +1,9 @@
+module DotFiles
+
+  class Error < StandardError; end
+
+  module Errors
+    class AccessDenied < Error; end
+  end
+  
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification 
+name: dotfiles
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Adam Cooke
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-09-04 00:00:00 +01:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 5
+        - 0
+        version: 1.5.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 1
+        - 5
+        version: 1.1.5
+  type: :runtime
+  version_requirements: *id002
+description: 
+email: adam@atechmedia.com
+executables: 
+- dotfiles
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- lib/dot_files/command.rb
+- lib/dot_files/commands/files.rb
+- lib/dot_files/commands/help.rb
+- lib/dot_files/commands/setup.rb
+- lib/dot_files/config.rb
+- lib/dot_files/dispatch.rb
+- lib/dot_files/dsl.rb
+- lib/dot_files/errors.rb
+- lib/dot_files.rb
+- bin/dotfiles
+has_rdoc: true
+homepage: http://atechmedia.com
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: CLI client for the mydotfiles.com
+test_files: []
+