repo_forker 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e3578efae8d2b15899494806244f4e05ab2f1f8e
+  data.tar.gz: 1131fd5c1593e95eda0b5b0d034dff3b6846c5af
+SHA512:
+  metadata.gz: 5aa039118ecfc6cde636776d0d3abacf2173a9d437a9eacda7de36fc901e4ff9a7a40c51ed8717e555c731c0a8d8a44980a186fc1b280383a1e313fe150cd40b
+  data.tar.gz: b07db61b46f99c44d90f68a7c01d9e549f30cd167e5833d014a1df55c5a128b50a1ddd9e41ea4cedfe7408e027218160b664212d504480f2ec58ae7a399023da

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.travis.yml

@@ -0,0 +1,11 @@
+language: ruby
+cache: bundler
+script: 'bundle exec rspec'
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1.0
+  - ruby-head
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Torey Hickman
+
+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,44 @@
+# RepoForker
+
+![Travis CI Build Status](https://api.travis-ci.org/toreyhickman/repo-forker.svg?branch=master)
+
+This gem is written to facilitate the forking of a list of GitHub repositories from one user or organization to another.
+
+
+## Installation
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'repo_forker'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install repo_forker
+
+
+## Usage
+```ruby
+RepoForker.configure do |config|
+  config.api_key = "123456"
+  config.source  = "some-organization"
+  config.destination = "another-organization"
+end
+
+repo_list = ["some-repo", "some-other-repo"]
+
+RepoForker.fork(repo_list)
+# => { :successful_requests => ["some-repo"], :failed_requests => ["some-other-repo"] }
+```
+
+*Figure 1*. Example configuration and use of  RepoForker.
+
+In order for RepoForker to make requests to the GitHub API to fork repositories, it must be configured with a GitHub API key, source user/organization, and a destination user/organization.  After configuration is complete, prepare a list of repository names and tell RepoForker to fork the repositories.  (see Figure 1)
+
+
+## Contributing
+If you'd like to help improve RepoForker by adding a new feature, please fork the repository and submit a pull request for your feature branch. Also, please report any bugs that you find.

data/Rakefile

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

data/lib/repo_forker.rb

@@ -0,0 +1,35 @@
+require "net/http"
+
+require "repo_forker/version"
+require "repo_forker/configuration"
+require "repo_forker/forking_uri"
+require "repo_forker/client"
+require "repo_forker/forking_request"
+
+module RepoForker
+  extend Configuration
+
+  def self.client
+    @client ||= Client.new
+  end
+
+  def self.fork(repo_names = [])
+    repo_names.each_with_object(new_memo) do |repo_name, memo|
+      uri = ForkingURI.build(repo_name)
+      request_details = ForkingRequest.new(uri.request_uri)
+
+      response = client.request(request_details)
+      record(response, memo, repo_name)
+    end
+  end
+
+  private
+  def self.new_memo
+    { successful_requests: [], failed_requests: [] }
+  end
+
+  def self.record(response, memo, repo_name)
+    key = response.code == "202" ? :successful_requests : :failed_requests
+    memo[key] << repo_name
+  end
+end

data/lib/repo_forker/client.rb

@@ -0,0 +1,17 @@
+module RepoForker
+  class Client < Net::HTTP
+    def self.new(host = uri.host, port = uri.port)
+      super(host, port)
+    end
+
+    def initialize(host, port)
+      super
+      self.use_ssl = true
+    end
+
+    private
+    def self.uri
+      @uri ||= URI(RepoForker.endpoint)
+    end
+  end
+end

data/lib/repo_forker/configuration.rb

@@ -0,0 +1,32 @@
+module RepoForker
+  module Configuration
+    def self.extended(base)
+      base.reset
+    end
+
+    VALID_CONNECTION_KEYS = [:endpoint, :user_agent]
+    VALID_OPTIONS_KEYS = [:api_key, :source, :destination]
+    VALID_CONFIG_KEYS = VALID_CONNECTION_KEYS + VALID_OPTIONS_KEYS
+
+    DEFAULT_ENDPOINT = "https://api.github.com"
+    DEFAULT_USER_AGENT = "RepoForker Ruby Gem #{RepoForker::VERSION}"
+
+    DEFAULT_API_KEY = nil
+    DEFAULT_SOURCE = nil
+    DEFAULT_DESTINATION = nil
+
+    attr_accessor *VALID_CONFIG_KEYS
+
+    def configure
+      yield self if block_given?
+    end
+
+    def reset
+      self.endpoint = DEFAULT_ENDPOINT
+      self.user_agent = DEFAULT_USER_AGENT
+      self.api_key = DEFAULT_API_KEY
+      self.source = DEFAULT_SOURCE
+      self.destination = DEFAULT_DESTINATION
+    end
+  end
+end

data/lib/repo_forker/forking_request.rb

@@ -0,0 +1,18 @@
+module RepoForker
+  class ForkingRequest < Net::HTTP::Post
+    def initialize(path)
+      super
+      assign_user_agent_header
+      assign_authorization_header
+    end
+
+    private
+    def assign_user_agent_header
+      self["user-agent"] = RepoForker.user_agent
+    end
+
+    def assign_authorization_header
+      self["authorization"] = "token #{RepoForker.api_key}"
+    end
+  end
+end

data/lib/repo_forker/forking_uri.rb

@@ -0,0 +1,26 @@
+module RepoForker
+  class ForkingURI < URI::HTTPS
+    def self.build(repo_name)
+      super(build_params(repo_name))
+    end
+
+    private
+    def self.build_params(repo_name)
+      { :path  => build_path(repo_name),
+        :host  => build_host,
+        :query => build_query }
+    end
+
+    def self.build_path(repo_name)
+      "/repos/#{RepoForker.source}/#{repo_name}/forks"
+    end
+
+    def self.build_host
+      RepoForker.endpoint.sub(/\w+:\/\//, "")
+    end
+
+    def self.build_query
+      "organization=#{RepoForker.destination}"
+    end
+  end
+end

data/lib/repo_forker/version.rb

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

data/repo_forker.gemspec

@@ -0,0 +1,24 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'repo_forker/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "repo_forker"
+  spec.version       = RepoForker::VERSION
+  spec.authors       = ["Torey Hickman"]
+  spec.email         = ["torey@toreyhickman.com"]
+  spec.summary       = "Fork a list of repositories."
+  spec.description   = "This gem facilitates forking multiple repositories from one organization/user to another"
+  spec.homepage      = "https://github.com/toreyhickman/repo-forker"
+  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_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.2"
+end

data/spec/client_spec.rb

@@ -0,0 +1,23 @@
+require 'repo_forker'
+
+describe RepoForker::Client do
+  describe ".new" do
+    let(:client) { RepoForker::Client.new }
+
+    it "is a kind of Ruby Net::HTTP object" do
+      expect(client).to be_a_kind_of Net::HTTP
+    end
+
+    it "has the host of the GitHub api" do
+      expect(client.address).to eq "api.github.com"
+    end
+
+    it "uses 443 as its port" do
+      expect(client.port).to eq 443
+    end
+
+    it "uses ssl" do
+      expect(client.use_ssl?).to be true
+    end
+  end
+end

data/spec/forking_request_spec.rb

@@ -0,0 +1,39 @@
+require "repo_forker"
+
+describe RepoForker::ForkingRequest do
+
+  let(:request_path) { "/path_to_repo?with=options" }
+  let(:request) { RepoForker::ForkingRequest.new(request_path) }
+
+  let(:fake_api_key)    { "123456" }
+  let(:fake_user_agent) { "my app" }
+
+  before(:each) do
+    RepoForker.configure do |config|
+      config.api_key    = fake_api_key
+      config.user_agent = fake_user_agent
+    end
+  end
+
+  after(:each) do
+    RepoForker.reset
+  end
+
+  describe ".new" do
+    it "is a kind of Net::HTTP::Post object" do
+      expect(request).to be_a_kind_of Net::HTTP::Post
+    end
+
+    it "assigns the user-agent header" do
+      expect(request["user-agent"]).to eq RepoForker.user_agent
+    end
+
+    it "assigns the authorization header" do
+      expect(request["authorization"]).to eq "token #{RepoForker.api_key}"
+    end
+
+    it "has a path" do
+      expect(request.path).to eq request_path
+    end
+  end
+end

data/spec/forking_uri_spec.rb

@@ -0,0 +1,48 @@
+require 'repo_forker'
+
+describe RepoForker::ForkingURI do
+
+  let(:fake_api_key)     { "123456" }
+  let(:fake_source)      { "good-coder" }
+  let(:fake_destination) { "helper" }
+  let(:fake_repo_to_fork)     { "cool-library" }
+
+  before(:each) do
+    RepoForker.configure do |config|
+      config.api_key     = fake_api_key
+      config.source      = fake_source
+      config.destination = fake_destination
+    end
+  end
+
+  after(:each) do
+    RepoForker.reset
+  end
+
+  describe ".build" do
+    it "is a kind of Ruby URI::HTTPS object" do
+      expect(RepoForker::ForkingURI.build fake_repo_to_fork).to be_a_kind_of URI::HTTPS
+    end
+
+    it "has a path to request forking the repository" do
+      expected_path = "/repos/#{fake_source}/#{fake_repo_to_fork}/forks"
+      built_uri = RepoForker::ForkingURI.build(fake_repo_to_fork)
+
+      expect(built_uri.path).to eq expected_path
+    end
+
+    it "has a query string to specify the destination organization" do
+      expected_query_string = "organization=#{fake_destination}"
+      built_uri = RepoForker::ForkingURI.build(fake_repo_to_fork)
+
+      expect(built_uri.query).to eq expected_query_string
+    end
+
+    it "has a properly formatted request uri" do
+      expected_request_uri = "/repos/#{fake_source}/#{fake_repo_to_fork}/forks?organization=#{fake_destination}"
+      built_uri = RepoForker::ForkingURI.build(fake_repo_to_fork)
+
+      expect(built_uri.request_uri).to eq expected_request_uri
+    end
+  end
+end

data/spec/repo_forker_spec.rb

@@ -0,0 +1,96 @@
+require 'repo_forker'
+
+describe RepoForker do
+  it "has a version" do
+    expect(RepoForker::VERSION).to_not be_nil
+  end
+
+  describe "default values" do
+    RepoForker::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "has a default #{key}" do
+        constant_name = "DEFAULT_#{key.upcase}"
+        expected_default_value = RepoForker::Configuration.const_get(constant_name)
+        expect(RepoForker.send(key)).to eq expected_default_value
+      end
+    end
+  end
+
+  describe ".configure" do
+    after(:each) do
+      RepoForker.reset
+    end
+
+    RepoForker::Configuration::VALID_CONFIG_KEYS.each do |key|
+      it "sets the #{key}" do
+        RepoForker.configure do |config|
+          config.send("#{key}=", key)
+        end
+
+        expect(RepoForker.send(key)).to eq key
+      end
+    end
+  end
+
+  describe ".client" do
+    it "returns a Client object" do
+      expect(RepoForker.client).to be_an_instance_of RepoForker::Client
+    end
+  end
+
+  describe ".fork" do
+    let(:client) { RepoForker.client }
+
+    let(:repo_1) { "some_repo" }
+    let(:repo_2) { "some_other_repo" }
+    let(:list)   { [repo_1, repo_2] }
+
+    let(:mock_api_key)     { "123456" }
+    let(:mock_source)      { "good_coder" }
+    let(:mock_destination) { "helper" }
+
+    before(:each) do
+      RepoForker.configure do |config|
+        config.api_key     = mock_api_key
+        config.source      = mock_source
+        config.destination = mock_destination
+      end
+    end
+
+    after(:each) do
+      RepoForker.reset
+    end
+
+    it "makes a request to fork each repo in the list" do
+      allow(RepoForker).to receive(:record)
+      allow(client).to receive(:request)
+
+      list.each do |repo_name|
+        fake_uri = double("uri", request_uri: "/path/to/#{repo_name}")
+        allow(RepoForker::ForkingURI).to receive(:build).with(repo_name).and_return(fake_uri)
+
+        fake_request = double("request")
+        allow(RepoForker::ForkingRequest).to receive(:new).with(fake_uri.request_uri).and_return(fake_request)
+
+        expect(client).to receive(:request).with(fake_request)
+      end
+
+      RepoForker.fork list
+    end
+
+    it "returns a record of successful and failed requests" do
+      list.each do |repo_name|
+        fake_uri = double("uri", request_uri: "/path/to/#{repo_name}")
+        allow(RepoForker::ForkingURI).to receive(:build).with(repo_name).and_return(fake_uri)
+
+        fake_request = double("request")
+        allow(RepoForker::ForkingRequest).to receive(:new).with(fake_uri.request_uri).and_return(fake_request)
+      end
+
+      successful_response = double("success", code: "202")
+      failed_response = double("fail", code: "404")
+      allow(client).to receive(:request).and_return(successful_response, failed_response)
+
+      expect(RepoForker.fork list).to eq({ successful_requests: [repo_1], failed_requests: [repo_2] })
+    end
+  end
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: repo_forker
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Torey Hickman
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-05-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '3.2'
+description: This gem facilitates forking multiple repositories from one organization/user
+  to another
+email:
+- torey@toreyhickman.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/repo_forker.rb
+- lib/repo_forker/client.rb
+- lib/repo_forker/configuration.rb
+- lib/repo_forker/forking_request.rb
+- lib/repo_forker/forking_uri.rb
+- lib/repo_forker/version.rb
+- repo_forker.gemspec
+- spec/client_spec.rb
+- spec/forking_request_spec.rb
+- spec/forking_uri_spec.rb
+- spec/repo_forker_spec.rb
+homepage: https://github.com/toreyhickman/repo-forker
+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.4.3
+signing_key: 
+specification_version: 4
+summary: Fork a list of repositories.
+test_files:
+- spec/client_spec.rb
+- spec/forking_request_spec.rb
+- spec/forking_uri_spec.rb
+- spec/repo_forker_spec.rb