change_agent 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 637bed85fb1871ec16e91eccd2e654cacc3718b1
-  data.tar.gz: ac8434e78322e91231c2b8d446df980eb8472a94
+  metadata.gz: 1b4df46f6edb351d190c8e7473c65ba64a593add
+  data.tar.gz: 51785477c0e84d66cd88cb989a6b4eab7d9477ae
 SHA512:
-  metadata.gz: 6b12aa9d46caeefcd917f72bf9a2ca4f514dcb55044a5a559d24031c83e8747680879a1873578e1d5875faa31b4a19831726af3dc5f4f6de0dd6de287355252a
-  data.tar.gz: 652be6634b377ccba3b04bcadeafae8dc314e5fa3ccced55377e3e53dc6dd46a4de6eb5c8c97a9ca448ab98912020d8404ec8bd89f2a3a807f9f71b70e403355
+  metadata.gz: 111998eab4ab45e1ea323903b33ff38195f5b0b93064575123242b75de8cee1ff66af72a91fcfb832243d2b54e855bcf43d470e906acbd0fed470bf45e730a7e
+  data.tar.gz: f09329d554f48f12bf7b7e1841b559a251ee74416cd35609a242f51ea57292861781984afaa2330b6f6698fe151c435ea4e8c53ac5ce3b7ec49b4f72b36b6d2b

data/.gitignore

@@ -1,22 +1,8 @@
 *.gem
-*.rbc
 .bundle
 .config
-.yardoc
 Gemfile.lock
-InstalledFiles
-_yardoc
-coverage
-doc/
-lib/bundler/man
-pkg
-rdoc
-spec/reports
 test/tmp
-test/version_tmp
 tmp
 *.bundle
-*.so
-*.o
-*.a
-mkmf.log
+.env

data/README.md

@@ -12,6 +12,8 @@ But wait. What if I told you you could just commit each press release to Git, an
 
 Having built the first app more times then I'd like to admit, I thought I'd make a Gem to facilitate building lightweight apps that use Git to track changes to scraped documents (or whatever you want, really).
 
+Want to see it in action? Check out [this lightweight demo](https://github.com/benbalter/change_agent_demo), scrapping the White House RSS feed.
+
 ## Okay, I'm sold. How do I use it?
 
 ChangeAgent writes values to the file system based on a given key, and immediately commits the file to Git, providing you with both a snapshot and a timestamp for every change.
@@ -31,7 +33,7 @@ change_agent.get "foo"
 
 ### Namespaced usage
 
-Keys (files) are intended to be namespaced when logically grouped. In the above example, if you were storing congressional press releases, you might store Rep. Balter's Nov 26th press release on puppies as "balter/2014/11/26/puppies.html", or just "balter/2014-11-26-puppies.txt" or even just "balter/puppies".
+Keys (files) are intended to be namespaced when logically grouped. In the above example, if you were storing congressional press releases, you might store Rep. Balter's Nov 26th press release on puppies as `balter/2014/11/26/puppies.html`, or just `balter/2014-11-26-puppies.txt` or even just `balter/puppies`.
 
 ```ruby
 change_agent.set "foo/bar", "baz"
@@ -46,7 +48,7 @@ It's really up to you, but you'll get performance and usability bumps the more y
 ### Cloning an existing repo / datastore
 
 ```ruby
-repo = "https://github.com/benbalter/some_repo"
+repo = "https://github.com/benbalter/change_agent_demo"
 directory = "data"
 change_agent = ChangeAgent::Client.new(directory, repo)
 
@@ -56,14 +58,32 @@ change_agent.get("foo")
 
 ### Pushing and pulling
 
-Ready to push your Git repo to a server? Assuming you've already got a remote set up, it's as simple as
+Ready to push your Git repo to a server? It's as simple as:
 
 ```ruby
+# add a remote (if there's not already one from the clone)
+change_agent.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+
 # pull in the latest data
-change_agent.git.pull
+change_agent.pull
 
 # push the data
-change_agent.git.push
+change_agent.push
+
+# do both
+change_agent.sync
+```
+
+### Authentication
+
+By default, Change Agent supports [token-bassed authentication](https://github.com/blog/1270-easier-builds-and-deployments-using-git-over-https-and-oauth). Simply pass an OAuth token via the `GITHUB_TOKEN` environmental variable and ensure all remotes use the `https` protocol. Change Agent will take care of the rest. You'll likely want to use a bot account for this.
+
+Rugged supports additional authentication strategies (such as ssh key). For more information see [Rugged](https://github.com/libgit2/rugged/blob/master/lib/rugged/credentials.rb). Here's an example of how you might implement an alternative authentication mechanism:
+
+```ruby
+change_agent = ChangeAgent::Client.new "data", "https://github.com/benbalter/change_agent_demo"
+creds = Rugged::Credentials::UserPassword.new :username => "benbalter", :password => "passw0rd"
+change_agent.credentials = creds
 ```
 
 ## Project status

data/change_agent.gemspec

@@ -18,6 +18,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency "rugged"
+  spec.add_dependency "dotenv"
   spec.add_development_dependency "bundler", "~> 1.6"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "pry"

data/lib/change_agent.rb

@@ -1,8 +1,10 @@
 require_relative "change_agent/version"
 require_relative "change_agent/document"
+require_relative "change_agent/sync"
 require_relative "change_agent/client"
 require "rugged"
 require 'pathname'
+require "dotenv"
 
 module ChangeAgent
 
@@ -11,3 +13,5 @@ module ChangeAgent
   end
 
 end
+
+Dotenv.load

data/lib/change_agent/client.rb

@@ -1,6 +1,7 @@
 module ChangeAgent
   class Client
 
+    include ChangeAgent::Sync
     attr_accessor :directory
 
     def initialize(directory=nil, remote=nil)
@@ -12,14 +13,15 @@ module ChangeAgent
       if @remote.nil?
         @repo ||= Rugged::Repository.init_at directory
       else
-        @repo ||= Rugged::Repository.clone_at @remote, directory
+        @repo ||= Rugged::Repository.clone_at @remote, directory, {:credentials => credentials}
       end
     end
 
     def set(key, value)
       document = Document.new(key, self)
       document.contents = value
-      document.write
+      return unless document.changed?
+      document.save
       document
     end
 
@@ -38,5 +40,6 @@ module ChangeAgent
     def inspect
       "#<ChangeAgent::Client repo=\"#{directory}\">"
     end
+
   end
 end

data/lib/change_agent/document.rb

@@ -19,17 +19,14 @@ module ChangeAgent
     end
 
     def contents
-      @contents ||= begin
-        tree = repo.head.target.tree
-        blob = repo.lookup tree.path(path)[:oid]
-        blob.content
-      end
-    rescue Rugged::ReferenceError, Rugged::TreeError
-      nil
+      @contents ||= blob_contents
     end
 
-    def write
-      clean_path
+    def changed?
+      contents != blob_contents
+    end
+
+    def save
       oid = repo.write contents, :blob
       repo.index.add(path: path, oid: oid, mode: 0100644)
 
@@ -39,6 +36,7 @@ module ChangeAgent
         tree: repo.index.write_tree(repo),
         update_ref: 'HEAD'
     end
+    alias_method :write, :save
 
     def delete(file=path)
       repo.index.remove(file)
@@ -48,6 +46,8 @@ module ChangeAgent
         parents: [repo.head.target],
         tree: repo.index.write_tree(repo),
         update_ref: 'HEAD'
+    rescue Rugged::IndexError
+      false
     end
 
     def inspect
@@ -56,15 +56,11 @@ module ChangeAgent
 
     private
 
-    def clean_path
-      return if repo.empty?
-      dirs = []
+    def blob_contents
       tree = repo.head.target.tree
-      path.split("/").each do |part|
-        file = dirs.push(part).join("/")
-        delete(file) if tree.path(file)
-      end
-    rescue Rugged::TreeError
+      blob = repo.lookup tree.path(path)[:oid]
+      blob.content
+    rescue Rugged::ReferenceError, Rugged::TreeError
       nil
     end
   end

data/lib/change_agent/sync.rb

@@ -0,0 +1,102 @@
+module ChangeAgent
+  module Sync
+
+    class MergeConflict < StandardError; end
+    class MissingRemote < ArgumentError; end
+
+    attr_writer :credentials
+
+    DEFAULT_REMOTE = "origin"
+    DEFAULT_REMOTE_BRANCH = "origin/master"
+    DEFAULT_LOCAL_REF = "refs/heads/master"
+
+    # Default to token-based credentials passed as GITHUB_TOKEN
+    # Can be over ridden by overwritting @credentials with a
+    # different Rugged Credentialing method
+    def credentials
+      @credentials ||= Rugged::Credentials::UserPassword.new({
+         :username => "x-oauth-basic",
+         :password => ENV["GITHUB_TOKEN"]
+      })
+    end
+
+    # Helper method to return all remots
+    def remotes
+      repo.remotes
+    end
+
+    # Helper method to simplify adding a remote
+    def add_remote(name, url)
+      remotes.create name, url
+    end
+
+    # Does the current repo have at least a single remote?
+    def has_remotes?
+      remotes.count > 0
+    end
+
+    # Push to a remote
+    #
+    # Options:
+    #  :remote - the name of the remote (default: origin)
+    #  :ref    - the ref to push (default: "refs/heads/master")
+    def push(options={})
+      raise MissingRemote unless has_remotes?
+      options.merge! :remote => DEFAULT_REMOTE, :ref => DEFAULT_LOCAL_REF
+      remotes[options[:remote]].push([options[:ref]], {:credentials => credentials})
+    end
+
+    # Fetch a remote
+    #
+    # Options:
+    #  remote - the name of the remote (default: origin)
+    def fetch(remote=nil)
+      raise MissingRemote unless has_remotes?
+      repo.fetch(remote || DEFAULT_REMOTE, {:credentials => credentials})
+    end
+
+    # Merge two refs
+    #
+    # Options:
+    #  :from   - the remote ref (default: "origin/master")
+    #  :to     - the local ref  (default: "refs/heads/master")
+    def merge(options={})
+      options.merge! :from => DEFAULT_REMOTE_BRANCH, :to => DEFAULT_LOCAL_REF
+      theirs = repo.rev_parse options[:from]
+      ours = repo.rev_parse options[:to]
+
+      analysis = repo.merge_analysis(theirs)
+      return analysis if analysis.include? :up_to_date
+
+      base = repo.rev_parse(repo.merge_base(ours, theirs))
+      index = ours.tree.merge(theirs.tree, base.tree)
+
+      raise MergeConflict if index.conflicts?
+
+      Rugged::Commit.create(repo, {
+        parents: [ours, theirs],
+        tree: index.write_tree(repo),
+        message: "Merged `#{options[:from]}` into `#{options[:to].sub("refs/heads/", "")}`",
+        update_ref: options[:to]
+      })
+    end
+
+    # Fetch a remote and merge
+    #
+    # Options:
+    #  :remote - the name of the remote (default: origin)
+    #  :from   - the remote ref (default: "origin/master")
+    #  :to     - the local ref  (default: "refs/heads/master")
+    def pull(options={})
+      fetch(options[:remote])
+      merge(options)
+    end
+
+    # Perform both a pull and a push
+    #
+    # Will fail if any conflicts occur
+    def sync
+      pull && push
+    end
+  end
+end

data/lib/change_agent/version.rb

@@ -1,3 +1,3 @@
 module ChangeAgent
-  VERSION = "0.1.0"
+  VERSION = "0.2.0"
 end

data/script/cibuild

@@ -1,12 +1,9 @@
 #!/bin/sh
 
-git config --get user.name > /dev/null
-if [ $? -eq 1 ]; then
-  git config --global user.name "Your Name"
-fi
+set -e
 
-git config --get user.email > /dev/null
-if [ $? -eq 1 ]; then
+if [ "$CI" = "true" ]; then
+  git config --global user.name "Your Name"
   git config --global user.email "you@example.com"
 fi
 

data/test/helper.rb

@@ -6,7 +6,7 @@ require 'shoulda'
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 def tempdir
-  File.expand_path "../tmp", File.dirname(__FILE__)
+  File.expand_path "./tmp", File.dirname(__FILE__)
 end
 
 def init_tempdir

data/test/test_change_agent.rb

@@ -5,7 +5,11 @@ class TestChangeAgent < Minitest::Test
   def setup
     init_tempdir
   end
-  
+
+  def teardown
+    FileUtils.rm_rf tempdir
+  end
+
   should "return a ChangeAgent::Client" do
     assert_equal ChangeAgent::Client, ChangeAgent.init(tempdir).class
   end

data/test/test_change_agent_client.rb

@@ -58,4 +58,11 @@ class TestChangeAgentClient < Minitest::Test
   should "not err on an unknown value" do
     refute @client.get "does/not/exist"
   end
+
+  should "not double save a document" do
+    @client.set "foo", "bar"
+    sha = @client.repo.last_commit.oid
+    @client.set "foo", "bar"
+    assert_equal sha, @client.repo.last_commit.oid
+  end
 end

data/test/test_change_agent_document.rb

@@ -33,37 +33,55 @@ class TestChangeAgentDocument < Minitest::Test
   should "read a file's contents" do
     @document.contents = "bar"
     @document.write
+    @document.contents = nil # prevent caching
     assert_equal "bar", @document.contents
   end
 
   should "write a file's contents" do
     @document.contents = "bar"
     @document.write
+    @document.contents = nil # prevent caching
     assert_equal "bar", @client.get("foo")
   end
 
   should "commit the document to the repo" do
     @document.contents = "bar"
     @document.write
+    @document.contents = nil # prevent caching
     assert_equal "Updating #{@document.key}", @document.repo.last_commit.message
   end
 
   should "delete the document" do
     @document.contents = "bar"
     @document.write
+    @document.contents = nil # prevent caching
     assert @client.get "foo"
     @document.delete
     refute @client.get "foo"
     assert_equal "Removing #{@document.key}", @document.repo.last_commit.message
   end
 
-  should "clobber conflicting namespace" do
-    @document.contents = "bar"
-    @document.write
-
+  should "allow two files in the same folder" do
     doc = ChangeAgent::Document.new("foo/bar", @client)
     doc.contents = "baz"
     doc.write
+    doc.contents = nil # prevent caching
     assert_equal "baz", @client.get("foo/bar")
+
+    doc = ChangeAgent::Document.new("foo/bar2", @client)
+    doc.contents = "baz2"
+    doc.write
+    doc.contents = nil # prevent caching
+    assert_equal "baz2", @client.get("foo/bar2")
+  end
+
+  should "know if a file's changed" do
+    refute @document.changed?
+
+    @client.set "foo", "bar"
+    refute @document.changed?
+
+    @document.contents = "baz"
+    assert @document.changed?
   end
 end

data/test/test_change_agent_sync.rb

@@ -0,0 +1,62 @@
+require 'helper'
+
+class TestChangeAgentSync < Minitest::Test
+
+  def setup
+    init_tempdir
+    @client = ChangeAgent::Client.new tempdir
+    @demo = ChangeAgent::Client.new tempdir, "http://github.com/benbalter/change_agent_demo"
+  end
+
+  def teardown
+    FileUtils.rm_rf tempdir
+  end
+
+  should "return the remotes" do
+    assert_equal Rugged::RemoteCollection, @client.remotes.class
+  end
+
+  should "add remotes" do
+    assert_equal 0, @client.remotes.count
+    @client.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+    assert_equal 1, @client.remotes.count
+  end
+
+  should "know when the repo has remotes" do
+    refute @client.has_remotes?
+    @client.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+    assert @client.has_remotes?
+  end
+
+  should "fetch" do
+    @client.add_remote "origin", "https://github.com/benbalter/change_agent_demo"
+    assert_raises Rugged::ReferenceError do
+      @client.repo.rev_parse "origin/master"
+    end
+    @client.fetch
+    assert @client.repo.rev_parse "origin/master"
+  end
+
+  should "merge" do
+    head = @demo.repo.head.target.oid
+    @demo.repo.reset "d877861", :hard
+    assert @demo.merge
+    assert_equal "Merged `origin/master` into `master`", @demo.repo.last_commit.message
+    assert head != @demo.repo.head.target.oid
+  end
+
+  should "pull" do
+    head = @demo.repo.head.target.oid
+    @demo.repo.reset "d877861", :hard
+    assert @demo.pull
+    assert_equal "Merged `origin/master` into `master`", @demo.repo.last_commit.message
+    assert head != @demo.repo.head.target.oid
+  end
+
+  should "init credentials" do
+    ENV["GITHUB_TOKEN"] = "foo"
+    assert_equal Rugged::Credentials::UserPassword, @client.credentials.class
+    assert_equal "x-oauth-basic", @client.credentials.instance_variable_get("@username")
+    assert_equal "foo", @client.credentials.instance_variable_get("@password")
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: change_agent
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Ben Balter
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-11-27 00:00:00.000000000 Z
+date: 2014-11-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rugged
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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
@@ -97,6 +111,7 @@ files:
 - lib/change_agent.rb
 - lib/change_agent/client.rb
 - lib/change_agent/document.rb
+- lib/change_agent/sync.rb
 - lib/change_agent/version.rb
 - script/bootstrap
 - script/cibuild
@@ -106,6 +121,7 @@ files:
 - test/test_change_agent.rb
 - test/test_change_agent_client.rb
 - test/test_change_agent_document.rb
+- test/test_change_agent_sync.rb
 homepage: https://github.com/benbalter/change-agent
 licenses:
 - MIT
@@ -136,3 +152,4 @@ test_files:
 - test/test_change_agent.rb
 - test/test_change_agent_client.rb
 - test/test_change_agent_document.rb
+- test/test_change_agent_sync.rb