jist 1.4.0 → 1.5.0

data/README.md

@@ -145,6 +145,19 @@ Jist.login!
 This will take them through the process of obtaining an OAuth2 token, and storing it
 in `~/.jist`, where it can later be read by `Jist.gist`
 
+GitHub enterprise
+==================
+
+If you'd like `jist` to use your locally installed [Github Enterprise](https://enterprise.github.com/),
+you need to export the `GITHUB_URL` environment variable in your `~/.bashrc`.
+
+```bash
+export GITHUB_URL=http://github.internal.example.com/
+```
+
+Once you've done this and restarted your terminal (or run `source ~/.bashrc`), jist will
+automatically use github enterprise instead of the public github.com
+
 Configuration
 =============
 

data/lib/jist.rb

@@ -7,7 +7,7 @@ require 'uri'
 module Jist
   extend self
 
-  VERSION = '1.4.0'
+  VERSION = '1.5.0'
 
   # A list of clipboard commands with copy and paste support.
   CLIPBOARD_COMMANDS = {
@@ -17,8 +17,13 @@ module Jist
     'putclip' => 'getclip'
   }
 
-  GITHUB_API_URL = URI("https://api.github.com/")
-  GIT_IO_URL     = URI("http://git.io")
+  GITHUB_API_URL   = URI("https://api.github.com/")
+  GIT_IO_URL       = URI("http://git.io")
+
+  GITHUB_BASE_PATH = ""
+  GHE_BASE_PATH    = "/api/v3"
+
+  URL_ENV_NAME     = "GITHUB_URL"
 
   # Exception tag for errors raised while gisting.
   module Error;
@@ -78,10 +83,10 @@ module Jist
     if options[:anonymous]
       access_token = nil
     else
-      access_token = (options[:access_token] || File.read(File.expand_path("~/.jist")) rescue nil)
+      access_token = (options[:access_token] || File.read(auth_token_file) rescue nil)
     end
 
-    url = "/gists"
+    url = "#{base_path}/gists"
     url << "/" << CGI.escape(existing_gist) if existing_gist.to_s != ''
     url << "?access_token=" << CGI.escape(access_token) if access_token.to_s != ''
 
@@ -92,7 +97,7 @@ module Jist
     retried = false
 
     begin
-      response = http(GITHUB_API_URL, request)
+      response = http(api_url, request)
       if Net::HTTPSuccess === response
         on_success(response.body, options)
       else
@@ -144,7 +149,7 @@ module Jist
     end
     puts ""
 
-    request = Net::HTTP::Post.new("/authorizations")
+    request = Net::HTTP::Post.new("#{base_path}/authorizations")
     request.body = JSON.dump({
       :scopes => [:gist],
       :note => "The jist gem",
@@ -153,13 +158,13 @@ module Jist
     request.content_type = 'application/json'
     request.basic_auth(username, password)
 
-    response = http(GITHUB_API_URL, request)
+    response = http(api_url, request)
 
     if Net::HTTPCreated === response
-      File.open(File.expand_path("~/.jist"), 'w') do |f|
+      File.open(auth_token_file, 'w') do |f|
         f.write JSON.parse(response.body)['token']
       end
-      puts "Success! https://github.com/settings/applications"
+      puts "Success! #{ENV[URL_ENV_NAME] || "https://github.com/"}settings/applications"
     else
       raise "Got #{response.class} from gist: #{response.body}"
     end
@@ -198,7 +203,7 @@ module Jist
       http.request request
     end
   rescue Timeout::Error
-    raise "Could not connect to https://api.github.com/"
+    raise "Could not connect to #{api_url}"
   end
 
   # Called after an HTTP response to gist to perform post-processing.
@@ -233,7 +238,16 @@ module Jist
   #
   def copy(content)
     IO.popen(clipboard_command(:copy), 'r+') { |clip| clip.print content }
-    raise Error, 'Copying to clipboard failed.' unless paste == content
+
+    unless paste == content
+      message = 'Copying to clipboard failed.'
+
+      if ENV["TMUX"] && clipboard_command(:copy) == 'pbcopy'
+        message << "\nIf you're running tmux on a mac, try http://robots.thoughtbot.com/post/19398560514/how-to-copy-and-paste-with-tmux-on-mac-os-x"
+      end
+
+      raise Error, message
+    end
   rescue Error => e
     raise ClipboardError, e.message + "\nAttempted to copy: #{content}"
   end
@@ -307,4 +321,22 @@ Could not find copy command, tried:
 
     `#{command} #{url}`
   end
+
+  # Get the API base path
+  def base_path
+    ENV.key?(URL_ENV_NAME) ? GHE_BASE_PATH : GITHUB_BASE_PATH
+  end
+
+  # Get the API URL
+  def api_url
+    ENV.key?(URL_ENV_NAME) ? URI(ENV[URL_ENV_NAME]) : GITHUB_API_URL
+  end
+
+  def auth_token_file
+    if ENV.key?(URL_ENV_NAME)
+      File.expand_path "~/.jist.#{ENV[URL_ENV_NAME].gsub(/[^a-z.]/, '')}"
+    else
+      File.expand_path "~/.jist"
+    end
+  end
 end

data/spec/ghe_spec.rb

@@ -0,0 +1,80 @@
+describe '...' do
+
+  MOCK_GHE_HOST     = 'ghe.example.com'
+  MOCK_GHE_PROTOCOL = 'http'
+  MOCK_USER         = 'foo'
+  MOCK_PASSWORD     = 'bar'
+
+  MOCK_AUTHZ_GHE_URL    = "#{MOCK_GHE_PROTOCOL}://#{MOCK_USER}:#{MOCK_PASSWORD}@#{MOCK_GHE_HOST}/api/v3/"
+  MOCK_GHE_URL          = "#{MOCK_GHE_PROTOCOL}://#{MOCK_GHE_HOST}/api/v3/"
+  MOCK_AUTHZ_GITHUB_URL = "https://#{MOCK_USER}:#{MOCK_PASSWORD}@api.github.com/"
+  MOCK_GITHUB_URL       = "https://api.github.com/"
+
+  before do
+    @saved_env = ENV[Jist::URL_ENV_NAME]
+
+    # stub requests for /gists
+    stub_request(:post, /#{MOCK_GHE_URL}gists/).to_return(:body => %[{"html_url": "http://#{MOCK_GHE_HOST}"}])
+    stub_request(:post, /#{MOCK_GITHUB_URL}gists/).to_return(:body => '{"html_url": "http://github.com/"}')
+
+    # stub requests for /authorizations
+    stub_request(:post, /#{MOCK_AUTHZ_GHE_URL}authorizations/).
+      to_return(:status => 201, :body => '{"token": "asdf"}')
+    stub_request(:post, /#{MOCK_AUTHZ_GITHUB_URL}authorizations/).
+      to_return(:status => 201, :body => '{"token": "asdf"}')
+  end
+
+  after do
+    ENV[Jist::URL_ENV_NAME] = @saved_env
+  end
+
+  describe :login! do
+    before do
+      @saved_stdin = $stdin
+
+      # stdin emulation
+      $stdin = StringIO.new "#{MOCK_USER}\n#{MOCK_PASSWORD}\n"
+
+      # intercept for updating ~/.jist
+      File.stub(:open)
+    end
+
+    after do
+      $stdin = @saved_stdin
+    end
+
+    it "should access to api.github.com when $#{Jist::URL_ENV_NAME} wasn't set" do
+      ENV.delete Jist::URL_ENV_NAME
+
+      Jist.login!
+
+      assert_requested(:post, /#{MOCK_AUTHZ_GITHUB_URL}authorizations/)
+    end
+
+    it "should access to #{MOCK_GHE_HOST} when $#{Jist::URL_ENV_NAME} was set" do
+      ENV[Jist::URL_ENV_NAME] = MOCK_GHE_URL
+
+      Jist.login!
+
+      assert_requested(:post, /#{MOCK_AUTHZ_GHE_URL}authorizations/)
+    end
+  end
+
+  describe :gist do
+    it "should access to api.github.com when $#{Jist::URL_ENV_NAME} wasn't set" do
+      ENV.delete Jist::URL_ENV_NAME
+
+      Jist.gist "test gist"
+
+      assert_requested(:post, /#{MOCK_GITHUB_URL}gists/)
+    end
+
+    it "should access to #{MOCK_GHE_HOST} when $#{Jist::URL_ENV_NAME} was set" do
+      ENV[Jist::URL_ENV_NAME] = MOCK_GHE_URL
+
+      Jist.gist "test gist"
+
+      assert_requested(:post, /#{MOCK_GHE_URL}gists/)
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: jist
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,72 +9,72 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-22 00:00:00.000000000 Z
+date: 2013-04-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: json
+  type: :runtime
   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
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  name: json
 - !ruby/object:Gem::Dependency
-  name: rake
+  type: :development
   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
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  name: rake
 - !ruby/object:Gem::Dependency
-  name: rspec
+  type: :development
   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
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  name: rspec
 - !ruby/object:Gem::Dependency
-  name: webmock
+  type: :development
   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
+  version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
+    none: false
+  prerelease: false
+  name: webmock
 description: Provides a single function (Jist.gist) that uploads a gist.
 email: conrad.irwin@gmail.com
 executables:
@@ -92,6 +92,7 @@ files:
 - jist.gemspec
 - lib/jist.rb
 - spec/clipboard_spec.rb
+- spec/ghe_spec.rb
 - spec/proxy_spec.rb
 - spec/shorten_spec.rb
 - spec/spec_helper.rb
@@ -103,20 +104,20 @@ 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
+required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+  none: false
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Just allows you to upload gists