spaarti 0.0.6 → 0.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e9a57c801b96b3809d34d8e9fd904b81980dfee4
-  data.tar.gz: dae03872a828d1fc299e5e72a98cf1a29b828ec8
+  metadata.gz: c42ba062b7a494cebed060c05573e29456f03fdc
+  data.tar.gz: 7f0ea344fc7cf4eccf66ab0e9ca0d6c10d97739b
 SHA512:
-  metadata.gz: bccf34e30b3b3132042040c97f59cec8c1cbbddb214620b26baf419e43cc904ca906ea249fee83f26eaf43c5f5dfca035dbd787557d52077b41d640cfe493b4a
-  data.tar.gz: 407d88057978eb2f57e007a605fb6253775612e69fefeaa841d5fbe275423b81e33d4cd14815ae3f985685c89886f5725c4638aa2483f6597a9ef71667d6ecd9
+  metadata.gz: 8b07d2daf7693308084d93e72752cdb716d1a68a7fa41a72674ab6f09bfd19c96d2d53ce2e2459ab307ed3d1acc7153e64ce91f3884ca251530d9840d6ca0c1a
+  data.tar.gz: 827d5277721187b041c163691026c4bf3749eb923211434913856664c8fcc479d9a7da73f500e305d30f3442ce3441dfc39b1aac219ac300dc3e7b7c240a3e94

data/.gitignore

@@ -3,3 +3,4 @@ coverage/
 .coveralls.yml
 .bundle
 Gemfile.lock
+tmp

data/README.md

@@ -12,6 +12,27 @@ Tool to maintain local clones of repos you have access to on GitHub
 
 ## Usage
 
+To clone all your repos to the current directory: `spaarti`
+
+Adding `-p` will remove orphaned repos (repos on disk that don't exist on GitHub, or that you no longer have access to).
+
+Adding `-q` will silence output except errors.
+
+You can override the defaults by defining a config file in YAML:
+
+```
+base_path: Defaults to './', this is the root that repos will be cloned to
+auth_file: Passed to OctoAuth for storing your GitHub token, the default will use ~/.octoauth.yml
+exclude: Hash where keys are attributes of a repo (https://developer.github.com/v3/repos/#get) and values are array of regex pattern strings, with any repo whose attribute matches any pattern not being pulled
+format: Format string used to determine path. Defaults to "%{full_name}", so "akerl/blog" is cloned at "akerl/blog". Available keys: https://developer.github.com/v3/repos/#get
+git_config: Hash of key/value pairs, will be set in .git/config for cloned repos. Useful for setting things like user.name/email
+quiet: Boolean, controls verbosity of status output
+purge: Boolean, true will remove repos that are on-disk but not accessible by you on GitHub
+url_type: Used to determine how to clone, one of: html, clone, git, ssh, svn. Defaults to 'ssh'
+```
+
+The default config path is `~/.spaarti.yml`, but you can provide an alternate path with `./spaarti -c /path/to/config`
+
 ## Installation
 
     gem install spaarti

data/lib/spaarti/repo.rb

@@ -39,12 +39,16 @@ module Spaarti
       err(error_msg) unless res
     end
 
+    def url
+      @url ||= @data["#{@options[:url_type]}_url".to_sym]
+    end
+
     def clone
       return log("#{@data[:full_name]} already cloned") if Dir.exist? @path
-      log "Cloning #{@data[:ssh_url]} to #{@path}"
+      log "Cloning #{url} to #{@path}"
       run(
-        "git clone '#{@data[:ssh_url]}' '#{@path}' &>/dev/null",
-        "Failed to clone #{@data[:ssh_url]}"
+        "git clone '#{url}' '#{@path}' &>/dev/null",
+        "Failed to clone #{url}"
       )
     end
 

data/lib/spaarti/site.rb

@@ -13,9 +13,10 @@ module Spaarti
     config_file: File.expand_path('~/.spaarti.yml'),
     exclude: [],
     format: '%{full_name}',
-    git_config: [],
+    git_config: {},
     quiet: false,
-    purge: false
+    purge: false,
+    url_type: 'ssh'
   }
 
   ##
@@ -24,6 +25,7 @@ module Spaarti
     def initialize(params = {})
       @options = DEFAULT_OPTIONS.dup.merge params
       load_config(params.include? :config_file)
+      auth
     end
 
     def sync!
@@ -71,13 +73,15 @@ module Spaarti
 
     def repos
       @repos ||= client.repos.map do |data|
-        next if excluded(data.name) || excluded(data.full_name)
+        next if excluded(data)
         Repo.new data.to_h, client, @options
-      end
+      end.compact
     end
 
-    def excluded(string)
-      @options[:exclude].any? { |x| string.match(x) }
+    def excluded(data)
+      @options[:exclude].any? do |key, patterns|
+        patterns.any? { |pattern| data[key].match pattern }
+      end
     end
   end
 end

data/lib/spaarti/version.rb

@@ -1,5 +1,5 @@
 ##
 # Set the version (needed for Mercenary -v)
 module Spaarti
-  VERSION = '0.0.6'
+  VERSION = '0.1.0'
 end

data/spaarti.gemspec

@@ -17,14 +17,16 @@ Gem::Specification.new do |s|
   s.test_files  = `git ls-files spec/*`.split
   s.executables = ['spaarti']
 
-  s.add_dependency 'octokit', '~> 3.7.0'
-  s.add_dependency 'octoauth', '~> 1.0.0'
+  s.add_dependency 'octokit', '~> 3.8.0'
+  s.add_dependency 'octoauth', '~> 1.0.1'
   s.add_dependency 'mercenary', '~> 0.3.4'
   s.add_dependency 'cymbal', '~> 1.0.0'
 
   s.add_development_dependency 'rubocop', '~> 0.29.0'
   s.add_development_dependency 'rake', '~> 10.4.0'
-  s.add_development_dependency 'coveralls', '~> 0.7.0'
+  s.add_development_dependency 'coveralls', '~> 0.8.0'
   s.add_development_dependency 'rspec', '~> 3.2.0'
   s.add_development_dependency 'fuubar', '~> 2.0.0'
+  s.add_development_dependency 'webmock', '~> 1.21.0'
+  s.add_development_dependency 'vcr', '~> 2.9.2'
 end

data/spec/bin_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Spaarti do
+end

data/spec/examples/auth.yml

@@ -0,0 +1,2 @@
+---
+spaarti: sekrit

data/spec/examples/config.yml

@@ -0,0 +1,4 @@
+base_path: tmp/base
+quiet: true
+auth_file: spec/examples/auth.yml
+url_type: git

data/spec/fixtures/cassettes/repos.yml

@@ -0,0 +1,72 @@
+---
+http_interactions:
+- request:
+    method: get
+    uri: https://api.github.com/user/repos?per_page=100
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      Accept:
+      - application/vnd.github.moondragon+json
+      User-Agent:
+      - Octokit Ruby Gem 3.8.0
+      Content-Type:
+      - application/json
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Server:
+      - GitHub.com
+      Date:
+      - Sun, 05 Apr 2015 14:56:23 GMT
+      Content-Type:
+      - application/json; charset=utf-8
+      Transfer-Encoding:
+      - chunked
+      Status:
+      - 200 OK
+      X-Ratelimit-Limit:
+      - '5000'
+      X-Ratelimit-Remaining:
+      - '4998'
+      X-Ratelimit-Reset:
+      - '1428249267'
+      Cache-Control:
+      - private, max-age=60, s-maxage=60
+      X-Oauth-Scopes:
+      - repo
+      X-Accepted-Oauth-Scopes:
+      - ''
+      Vary:
+      - Accept, Authorization, Cookie, X-GitHub-OTP
+      - Accept-Encoding
+      X-Github-Media-Type:
+      - github.moondragon; format=json
+      X-Xss-Protection:
+      - 1; mode=block
+      X-Frame-Options:
+      - deny
+      Content-Security-Policy:
+      - default-src 'none'
+      Access-Control-Allow-Credentials:
+      - 'true'
+      Access-Control-Expose-Headers:
+      - ETag, Link, X-GitHub-OTP, X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset,
+        X-OAuth-Scopes, X-Accepted-OAuth-Scopes, X-Poll-Interval
+      Access-Control-Allow-Origin:
+      - "*"
+      Strict-Transport-Security:
+      - max-age=31536000; includeSubdomains; preload
+      X-Content-Type-Options:
+      - nosniff
+    body:
+      encoding: ASCII-8BIT
+      string: '[{"id":23901941,"name":"spaarti","full_name":"akerl/spaarti","owner":{"login":"akerl","id":491209,"avatar_url":"https://avatars.githubusercontent.com/u/491209?v=3","gravatar_id":"","url":"https://api.github.com/users/akerl","html_url":"https://github.com/akerl","followers_url":"https://api.github.com/users/akerl/followers","following_url":"https://api.github.com/users/akerl/following{/other_user}","gists_url":"https://api.github.com/users/akerl/gists{/gist_id}","starred_url":"https://api.github.com/users/akerl/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/akerl/subscriptions","organizations_url":"https://api.github.com/users/akerl/orgs","repos_url":"https://api.github.com/users/akerl/repos","events_url":"https://api.github.com/users/akerl/events{/privacy}","received_events_url":"https://api.github.com/users/akerl/received_events","type":"User","site_admin":false},"private":false,"html_url":"https://github.com/akerl/spaarti","description":"Tool to maintain local clones of repos you have access to on GitHub","fork":false,"url":"https://api.github.com/repos/akerl/spaarti","forks_url":"https://api.github.com/repos/akerl/spaarti/forks","keys_url":"https://api.github.com/repos/akerl/spaarti/keys{/key_id}","collaborators_url":"https://api.github.com/repos/akerl/spaarti/collaborators{/collaborator}","teams_url":"https://api.github.com/repos/akerl/spaarti/teams","hooks_url":"https://api.github.com/repos/akerl/spaarti/hooks","issue_events_url":"https://api.github.com/repos/akerl/spaarti/issues/events{/number}","events_url":"https://api.github.com/repos/akerl/spaarti/events","assignees_url":"https://api.github.com/repos/akerl/spaarti/assignees{/user}","branches_url":"https://api.github.com/repos/akerl/spaarti/branches{/branch}","tags_url":"https://api.github.com/repos/akerl/spaarti/tags","blobs_url":"https://api.github.com/repos/akerl/spaarti/git/blobs{/sha}","git_tags_url":"https://api.github.com/repos/akerl/spaarti/git/tags{/sha}","git_refs_url":"https://api.github.com/repos/akerl/spaarti/git/refs{/sha}","trees_url":"https://api.github.com/repos/akerl/spaarti/git/trees{/sha}","statuses_url":"https://api.github.com/repos/akerl/spaarti/statuses/{sha}","languages_url":"https://api.github.com/repos/akerl/spaarti/languages","stargazers_url":"https://api.github.com/repos/akerl/spaarti/stargazers","contributors_url":"https://api.github.com/repos/akerl/spaarti/contributors","subscribers_url":"https://api.github.com/repos/akerl/spaarti/subscribers","subscription_url":"https://api.github.com/repos/akerl/spaarti/subscription","commits_url":"https://api.github.com/repos/akerl/spaarti/commits{/sha}","git_commits_url":"https://api.github.com/repos/akerl/spaarti/git/commits{/sha}","comments_url":"https://api.github.com/repos/akerl/spaarti/comments{/number}","issue_comment_url":"https://api.github.com/repos/akerl/spaarti/issues/comments{/number}","contents_url":"https://api.github.com/repos/akerl/spaarti/contents/{+path}","compare_url":"https://api.github.com/repos/akerl/spaarti/compare/{base}...{head}","merges_url":"https://api.github.com/repos/akerl/spaarti/merges","archive_url":"https://api.github.com/repos/akerl/spaarti/{archive_format}{/ref}","downloads_url":"https://api.github.com/repos/akerl/spaarti/downloads","issues_url":"https://api.github.com/repos/akerl/spaarti/issues{/number}","pulls_url":"https://api.github.com/repos/akerl/spaarti/pulls{/number}","milestones_url":"https://api.github.com/repos/akerl/spaarti/milestones{/number}","notifications_url":"https://api.github.com/repos/akerl/spaarti/notifications{?since,all,participating}","labels_url":"https://api.github.com/repos/akerl/spaarti/labels{/name}","releases_url":"https://api.github.com/repos/akerl/spaarti/releases{/id}","created_at":"2014-09-11T03:05:28Z","updated_at":"2015-04-05T14:20:01Z","pushed_at":"2015-04-05T14:20:00Z","git_url":"git://github.com/akerl/spaarti.git","ssh_url":"git@github.com:akerl/spaarti.git","clone_url":"https://github.com/akerl/spaarti.git","svn_url":"https://github.com/akerl/spaarti","homepage":"","size":364,"stargazers_count":0,"watchers_count":0,"language":"Ruby","has_issues":true,"has_downloads":true,"has_wiki":false,"has_pages":false,"forks_count":0,"mirror_url":null,"open_issues_count":2,"forks":0,"open_issues":2,"watchers":0,"default_branch":"master","master_branch":"master","permissions":{"admin":true,"push":true,"pull":true}}]'
+    http_version: 
+  recorded_at: Sun, 05 Apr 2015 14:56:23 GMT
+recorded_with: VCR 2.9.3

data/spec/spaarti/repo_spec.rb

@@ -0,0 +1,4 @@
+require 'spec_helper'
+
+describe Spaarti do
+end

data/spec/spaarti/site_spec.rb

@@ -0,0 +1,61 @@
+require 'spec_helper'
+require 'fileutils'
+
+describe Spaarti do
+  describe 'Site' do
+    let(:path) { 'tmp/base' }
+    let(:config) { 'spec/examples/config.yml' }
+    let(:subject) { Spaarti::Site.new config_file: config }
+
+    before(:each) do
+      FileUtils.rm_rf path
+      FileUtils.mkdir_p path
+    end
+
+    describe '#sync!' do
+      it 'clones repo' do
+        expect(File.exist? "#{path}/akerl/spaarti/.git").to be_falsey
+        VCR.use_cassette('repos') { subject.sync! }
+        expect(File.exist? "#{path}/akerl/spaarti/.git").to be_truthy
+      end
+
+      context 'with purge enabled' do
+        it 'purges repos that are orphaned' do
+          FileUtils.mkdir_p "#{path}/akerl/orphan/.git"
+          VCR.use_cassette('repos') do
+            Spaarti::Site.new(purge: true, config_file: config).sync!
+          end
+          expect(File.exist? "#{path}/akerl/orphan").to be_falsey
+        end
+      end
+      context 'with purge disabled' do
+        it 'does not purge repos that are orphaned' do
+          FileUtils.mkdir_p "#{path}/akerl/orphan/.git"
+          VCR.use_cassette('repos') do
+            Spaarti::Site.new(purge: false, config_file: config).sync!
+          end
+          expect(File.exist? "#{path}/akerl/orphan").to be_truthy
+        end
+      end
+
+      it 'supports excluding repos' do
+        VCR.use_cassette('repos') do
+          Spaarti::Site.new(
+            exclude: { full_name: ['[ab]a'] }, config_file: config
+          ).sync!
+        end
+        expect(File.exist? "#{path}/akerl/spaarti").to be_falsey
+      end
+    end
+
+    describe '#purge!' do
+      it 'purges repos that are orphaned' do
+        FileUtils.mkdir_p "#{path}/akerl/orphan/.git"
+        VCR.use_cassette('repos') do
+          Spaarti::Site.new(purge: true, config_file: config).sync!
+        end
+        expect(File.exist? "#{path}/akerl/orphan").to be_falsey
+      end
+    end
+  end
+end

data/spec/spaarti_spec.rb

@@ -1 +1,9 @@
 require 'spec_helper'
+
+describe Spaarti do
+  describe '#new' do
+    it 'creates a Site object' do
+      expect(Spaarti.new).to be_an_instance_of Spaarti::Site
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -8,3 +8,15 @@ end
 
 require 'rspec'
 require 'spaarti'
+
+require 'vcr'
+VCR.configure do |c|
+  c.cassette_library_dir = 'spec/fixtures/cassettes'
+  c.hook_into :webmock
+  c.before_record do |i|
+    i.request.headers.delete 'Authorization'
+    %w(Etag X-Github-Request-Id X-Served-By).each do |header|
+      i.response.headers.delete header
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spaarti
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.1.0
 platform: ruby
 authors:
 - Les Aker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-20 00:00:00.000000000 Z
+date: 2015-04-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: octokit
@@ -16,28 +16,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.7.0
+        version: 3.8.0
 - !ruby/object:Gem::Dependency
   name: octoauth
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.0
+        version: 1.0.1
 - !ruby/object:Gem::Dependency
   name: mercenary
   requirement: !ruby/object:Gem::Requirement
@@ -100,14 +100,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.0
+        version: 0.8.0
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.21.0
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.9.2
 description: Maintain local clones of repos you have access to on GitHub
 email: me@lesaker.org
 executables:
@@ -157,6 +185,12 @@ files:
 - lib/spaarti/site.rb
 - lib/spaarti/version.rb
 - spaarti.gemspec
+- spec/bin_spec.rb
+- spec/examples/auth.yml
+- spec/examples/config.yml
+- spec/fixtures/cassettes/repos.yml
+- spec/spaarti/repo_spec.rb
+- spec/spaarti/site_spec.rb
 - spec/spaarti_spec.rb
 - spec/spec_helper.rb
 homepage: https://github.com/akerl/spaarti
@@ -184,5 +218,11 @@ signing_key:
 specification_version: 4
 summary: Helper for cloning GitHub repos
 test_files:
+- spec/bin_spec.rb
+- spec/examples/auth.yml
+- spec/examples/config.yml
+- spec/fixtures/cassettes/repos.yml
+- spec/spaarti/repo_spec.rb
+- spec/spaarti/site_spec.rb
 - spec/spaarti_spec.rb
 - spec/spec_helper.rb