gistdoit 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ece0f942669210dc40e8fbaf2db709335256de73
+  data.tar.gz: f9a48589427c881d5ae161baf4053c44ef253c2e
+SHA512:
+  metadata.gz: 4af73a7269ac649058686d9b24991e9c5f86abf41eaabe2ba0fdc8c7349cb4f8710876d0863a70d651f5d2239610c68d605cb67ff9c071c61ad8a681bd8b5187
+  data.tar.gz: 483a301c478082c87e50b2ab32bd0fbf125d50b126655a05e2da2bd0c0ec8137daab4b0c3e8072ae221494b655c5f8a5609080ae798a3dfe9b6c908d79c20806

data/.gitignore

@@ -0,0 +1,5 @@
+config.yml
+TODO_before_committing
+*.gem
+sketch.md
+playground/*

data/README.md

@@ -0,0 +1,51 @@
+This simple Ruby utility takes a file on your local machine and turns it into a gist on Github.
+
+I could have used gems to simplify the development process, but I'm not sure how much code that would have actually saved me writing, and it would have undoubtedly added a layer of complexity in terms of understanding the codebase, so I decided to use only libraries which are built in to Ruby itself.
+
+### Getting started
+
+`gem install gistdoit`
+
+### Usage
+
+To create a new gist, you simply type `gistdoit` along with the relative file path for the file you want to make a gist out of
+
+```
+// PWD is /Users/AwesomeUser/Dev/Projects
+
+gistdoit cool_project_file.rb
+```
+
+If you want to edit a file that is currently on Github, then you can pass the `patch` flag
+
+```
+// PWD is /Users/AwesomeUser/Dev/Projects
+
+gistdoit patch cool_project_file.rb
+```
+
+If you like to update your gists remotely on Github, then we recommend that you first make sure that your local gist is up to date with the remote version
+
+```
+// PWD is /Users/AwesomeUser/Dev/Projects
+
+gistdoit pull cool_project_file.rb
+
+// Gistdoit needs permission to update the file
+Password: ********
+
+The file was successfully updated!
+```
+
+At the moment, Gistdoit only recognizes files which were added to gist.github via Gistdoit. 
+
+### Internals
+
+Gistdoit keeps a record of the full file paths for gists you've uploaded to Github via Gistdoit along with the slug for that file, and a SHA of the file itself. This allows Gistdoit to quickly check for changes in the file without having to parse it.
+
+### Things I would like to add in the future
+
+- Allowing the user to select whether they would like a gist to be either secret or public.
+- Listing all gists which the option of limited to a certain number of most recent.
+- Editing a particular gist after selecting it by name.
+- Show the diff of what was changed when files are updated

data/Rakefile

@@ -0,0 +1,7 @@
+task :test do
+  Dir.glob('./test/*_test.rb').each do |test_file|
+    require test_file
+  end
+end
+
+task :default => :test

data/bin/gistdoit

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift(File.expand_path('../../lib', __FILE__))
+require 'gistdoit'
+
+GistDoIt::CLI.start(*ARGV)
+

data/content.rb

@@ -0,0 +1 @@
+puts 'hello'

data/gistdoit.gemspec

@@ -0,0 +1,18 @@
+$:.unshift(File.expand_path("../lib", __FILE__))
+require 'gistdoit/version'
+
+Gem::Specification.new do |s|
+  s.name = "gistdoit"
+  s.version = "0.0.0"
+  s.date = "2015-08-28"
+  s.summary = "File to Gist converter"
+  s.description = "An easy way to convert your files to Gists all within the terminal"
+  s.authors = ["Liam Brady"]
+  s.email = "liamseanbrady+gems@gmail.com"
+  s.executables = %w[gistdoit]
+  s.files = `git ls-files`.split("\n").reject { |file_name| file_name == 'sketch.md' }
+  s.test_files = `git ls-files -- test/*`.split("\n")
+  s.require_paths = %w[lib]
+  s.version = GistDoIt::VERSION
+  s.homepage = "http://github.com/liamseanbrady/gistdoit"
+end

data/lib/gistdoit.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'gistdoit/github/client'
+require 'gistdoit/net_http_adapter'
+require 'gistdoit/github/user_config'
+require 'gistdoit/gist'
+require 'gistdoit/cli'

data/lib/gistdoit/cli.rb

@@ -0,0 +1,68 @@
+require 'json'
+
+module GistDoIt
+  class CLI
+    def self.start(*args)
+      new.start(args.first)
+    end
+
+    def start(relative_file_path)
+      base_file_name = File.basename(relative_file_path)
+      file_contents = get_file_contents(relative_file_path)
+      description = get_file_description
+      create_gist(base_file_name, file_contents, description)
+    end
+
+    def create_gist(base_file_name, file_contents, description)
+      gist = Gist.new(name: base_file_name, content: file_contents, summary: description)
+      client = Github::Client.new
+      response = client.create_gist(gist)
+      parsed_response = JSON.parse(response)
+      client.github_username = parsed_response['owner']['login'] unless client.has_github_username?
+      show_url(parsed_response['html_url'])
+    end
+
+    def show_url(url)
+      in_blank_terminal do
+        puts "The link is: #{url}"
+      end
+    end
+
+    def get_file_contents(relative_file_path)
+      path = Dir.pwd
+      File.read("#{path}/#{relative_file_path}")
+    end
+
+    def base_file_name(path)
+      File.basename(path)
+    end
+    
+    def get_file_description
+      in_blank_terminal do
+        puts "Please describe your file..."
+        description = $stdin.gets.chomp
+      end
+    end
+
+    def in_blank_terminal
+      system 'clear'
+      yield
+    end
+
+    def get_token
+      in_blank_terminal do
+        config_path = File.expand_path('~') + '/.gistdoit'
+        if !File.exist?(config_path)
+          in_blank_terminal do
+            puts "Please enter your token:"
+            token = $stdin.gets.chomp
+          end
+          result = File.open(config_path, 'w') do |file|
+            config_data = { 'token' => token }
+            file << YAML.dump(config_data)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/gistdoit/gist.rb

@@ -0,0 +1,45 @@
+require 'yaml'
+require 'gistdoit/github/user_config'
+
+module GistDoIt
+  class Gist
+    def initialize(name: nil, content: nil, summary: nil, user_config: Github::UserConfig.new)
+      @name = name
+      @content = content
+      @summary = summary
+      @config = user_config
+    end
+
+    def github_username
+      @config.username
+    end
+
+    def content=(file_contents)
+      @content = file_contents
+    end
+
+    def content
+      @content
+    end
+
+    def summary
+      @summary
+    end
+
+    def summary=(text)
+      @summary = text
+    end
+
+    def name
+      @name
+    end
+
+    def name=(text)
+      @name = text
+    end
+    
+    def to_json
+      { "description" => "#{summary}", "public" => false, "files" => { "#{name}" => { "content" => "#{content}" } } }.to_json
+    end
+  end
+end

data/lib/gistdoit/github/client.rb

@@ -0,0 +1,35 @@
+require 'json'
+require 'yaml'
+require_relative '../net_http_adapter'
+require_relative './user_config'
+
+module Github
+  class Client
+    def initialize(config = UserConfig.new, network = GistDoIt::NetHTTPAdapter.new)
+      @config = config
+      @network = network
+    end
+
+    def create_gist(gist)
+      @data = gist.to_json
+      uri = URI("https://api.github.com/gists")
+      @response = @network.post_with_token(token, uri, @data)
+    end
+
+    def has_github_username?
+      @config.has_github_username?
+    end
+
+    def github_username=(username)
+      @config.set_github_username(username)
+    end
+
+    def response
+      @response
+    end
+
+    def token
+      @config.token
+    end
+  end
+end

data/lib/gistdoit/github/user_config.rb

@@ -0,0 +1,33 @@
+require 'yaml'
+
+module Github
+  class UserConfig
+    # Do we actually need an instance here. Do we require state at any point?
+    def initialize(file_path = File.expand_path('~') + '/.gistdoit')
+      @file_path = file_path
+    end
+
+    def set_github_username(username)
+      File.open(@file_path, 'a') do |file|
+        file << YAML.dump({ 'github_username' => username })
+      end
+    end
+
+    def has_github_username?
+      YAML.load(File.readlines(@file_path).select { |line| !line.include?('---') }.join).key?('github_username')
+    end
+
+    def all
+      file = File.read(@file_path)
+      YAML.load(file)
+    end
+
+    def [](key)
+      all[key]
+    end
+
+    def method_missing(symbol, *args)
+      all[symbol.to_s]
+    end
+  end
+end

data/lib/gistdoit/net_http_adapter.rb

@@ -0,0 +1,28 @@
+require 'net/http'
+
+module GistDoIt
+  class NetHTTPAdapter
+    def post_with_token(token, uri, data)
+      request = Net::HTTP::Post.new(uri.to_s)
+      add_headers_to_request!(request, {"content-type" => "application/json", "Authorization" => "token #{token}"})
+      add_body_to_request!(request, data)
+      Net::HTTP.start(uri.host, uri.port, :use_ssl => true) do |http|
+        @response = http.request(request).body
+      end
+
+      @response
+    end
+
+    private
+
+    def add_headers_to_request!(request, headers)
+      headers.each do |header_name, header_value|
+        request[header_name] = header_value
+      end
+    end
+
+    def add_body_to_request!(request, data)
+      request.body = data
+    end
+  end
+end

data/lib/gistdoit/version.rb

@@ -0,0 +1,3 @@
+module GistDoIt
+  VERSION = '0.0.1'
+end

data/test/client_test.rb

@@ -0,0 +1,68 @@
+require 'minitest/autorun'
+require_relative './test_helper'
+require 'gistdoit/github/client'
+
+module Github
+  class ClientTest < Minitest::Test
+    def setup
+      @gist_data = Struct.new(:gist_data) {
+        def username
+          'liamseanbrady'
+        end
+
+        def summary
+          'This is a cool gist'
+        end
+
+        def name
+          'file.rb'
+        end
+
+        def content
+          'def new_test; end'
+        end
+      }.new
+    end
+
+    def teardown
+      @gist_data = nil
+    end
+
+    def test_client_gets_response_from_service
+      fixture_path = File.expand_path('../fixtures/create_gist_response', __FILE__)
+      response = File.read(fixture_path)
+
+      user_config = Struct.new(:user_config) {
+        def token
+          'ab12345'
+        end
+      }.new
+
+      test_scope = self
+
+      network_adapter = Struct.new(:network_adapter) {
+        def post_with_token(token, uri, data)
+          fixture_path = File.expand_path('../fixtures/create_gist_response', __FILE__)
+          File.read(fixture_path)
+        end
+      }.new
+
+      client = Client.new(user_config, network_adapter)
+      client.create_gist(@gist_data)
+
+      assert_equal(response, client.response)
+    end
+
+    def test_token
+      user_config = Struct.new(:user_config) {
+        def token
+          'ab12345'
+        end
+      }.new
+        
+      client = Client.new(user_config)
+      
+      assert_equal('ab12345', client.token)
+    end
+  end
+end

data/test/command_line_test.rb

@@ -0,0 +1,4 @@
+require 'minitest/autorun'
+
+class CommandLineTest < Minitest::Test
+end

data/test/fixtures/create_gist_response

@@ -0,0 +1,80 @@
+{
+  "url": "https://api.github.com/gists/e0e1a3cddec61ee89289",
+  "forks_url": "https://api.github.com/gists/e0e1a3cddec61ee89289/forks",
+  "commits_url": "https://api.github.com/gists/e0e1a3cddec61ee89289/commits",
+  "id": "e0e1a3cddec61ee89289",
+  "git_pull_url": "https://gist.github.com/e0e1a3cddec61ee89289.git",
+  "git_push_url": "https://gist.github.com/e0e1a3cddec61ee89289.git",
+  "html_url": "https://gist.github.com/e0e1a3cddec61ee89289",
+  "files": {
+    "file1.txt": {
+      "filename": "file1.txt",
+      "type": "text/plain",
+      "language": "Text",
+      "raw_url": "https://gist.githubusercontent.com/liamseanbrady/e0e1a3cddec61ee89289/raw/043a3b46337b46164a5626816c2984b48be968ea/file1.txt",
+      "size": 4,
+      "truncated": false,
+      "content": "Demo"
+    }
+  },
+  "public": false,
+  "created_at": "2015-08-24T12:12:50Z",
+  "updated_at": "2015-08-24T12:12:50Z",
+  "description": "Created via API",
+  "comments": 0,
+  "user": null,
+  "comments_url": "https://api.github.com/gists/e0e1a3cddec61ee89289/comments",
+  "owner": {
+    "login": "liamseanbrady",
+    "id": 8338057,
+    "avatar_url": "https://avatars.githubusercontent.com/u/8338057?v=3",
+    "gravatar_id": "",
+    "url": "https://api.github.com/users/liamseanbrady",
+    "html_url": "https://github.com/liamseanbrady",
+    "followers_url": "https://api.github.com/users/liamseanbrady/followers",
+    "following_url": "https://api.github.com/users/liamseanbrady/following{/other_user}",
+    "gists_url": "https://api.github.com/users/liamseanbrady/gists{/gist_id}",
+    "starred_url": "https://api.github.com/users/liamseanbrady/starred{/owner}{/repo}",
+    "subscriptions_url": "https://api.github.com/users/liamseanbrady/subscriptions",
+    "organizations_url": "https://api.github.com/users/liamseanbrady/orgs",
+    "repos_url": "https://api.github.com/users/liamseanbrady/repos",
+    "events_url": "https://api.github.com/users/liamseanbrady/events{/privacy}",
+    "received_events_url": "https://api.github.com/users/liamseanbrady/received_events",
+    "type": "User",
+    "site_admin": false
+  },
+  "forks": [
+
+  ],
+  "history": [
+    {
+      "user": {
+        "login": "liamseanbrady",
+        "id": 8338057,
+        "avatar_url": "https://avatars.githubusercontent.com/u/8338057?v=3",
+        "gravatar_id": "",
+        "url": "https://api.github.com/users/liamseanbrady",
+        "html_url": "https://github.com/liamseanbrady",
+        "followers_url": "https://api.github.com/users/liamseanbrady/followers",
+        "following_url": "https://api.github.com/users/liamseanbrady/following{/other_user}",
+        "gists_url": "https://api.github.com/users/liamseanbrady/gists{/gist_id}",
+        "starred_url": "https://api.github.com/users/liamseanbrady/starred{/owner}{/repo}",
+        "subscriptions_url": "https://api.github.com/users/liamseanbrady/subscriptions",
+        "organizations_url": "https://api.github.com/users/liamseanbrady/orgs",
+        "repos_url": "https://api.github.com/users/liamseanbrady/repos",
+        "events_url": "https://api.github.com/users/liamseanbrady/events{/privacy}",
+        "received_events_url": "https://api.github.com/users/liamseanbrady/received_events",
+        "type": "User",
+        "site_admin": false
+      },
+      "version": "3439bbd04f75067672425b9f51a11170c072aaf6",
+      "committed_at": "2015-08-24T12:12:50Z",
+      "change_status": {
+        "total": 1,
+        "additions": 1,
+        "deletions": 0
+      },
+      "url": "https://api.github.com/gists/e0e1a3cddec61ee89289/3439bbd04f75067672425b9f51a11170c072aaf6"
+    }
+  ]
+}

data/test/gist_test.rb

@@ -0,0 +1,54 @@
+require 'minitest/autorun'
+require_relative './test_helper'
+require 'gistdoit/gist'
+
+class GistTests < Minitest::Test
+  def test_gist_reads_username_from_config_file
+    user_config = Struct.new(:user_config) {
+      def username
+        'liamseanbrady'
+      end
+    }.new
+
+    gist = GistDoIt::Gist.new(user_config: user_config) 
+
+    assert_equal('liamseanbrady', gist.github_username)
+  end
+
+  def test_gist_has_a_summary
+    user_config = Struct.new(:user_config) {
+      def username
+        'liamseanbrady'
+      end
+    }.new
+
+    gist = GistDoIt::Gist.new(user_config: user_config, summary: 'A good summary')
+
+    assert_equal('A good summary', gist.summary)
+  end
+
+
+  def test_gist_has_a_name
+    user_config = Struct.new(:user_config) {
+      def username
+        'liamseanbrady'
+      end
+    }.new
+
+    gist = GistDoIt::Gist.new(user_config: user_config, name: 'my_gist.rb')
+
+    assert_equal('my_gist.rb', gist.name)
+  end
+
+  def test_gist_has_content
+    user_config = Struct.new(:user_config) {
+      def username
+        'liamseanbrady'
+      end
+    }.new
+
+    gist = GistDoIt::Gist.new(user_config: user_config, content: 'def new_method; end')
+
+    assert_equal('def new_method; end', gist.content)
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1 @@
+$:.unshift(File.dirname(__FILE__) + '/../lib')

data/test/user_config_test.rb

@@ -0,0 +1,39 @@
+require 'minitest/autorun'
+require_relative './test_helper'
+require 'gistdoit/github/user_config'
+
+module Github
+  class ConfigTest < Minitest::Test
+    def test_parses_yaml_from_file
+      config_file_path = File.expand_path('../fixtures/config.yml', __FILE__)
+      user_config = UserConfig.new(config_file_path)
+      config_data = { 'username' => 'liamseanbrady', 'token' => 'ab12345' }
+
+      assert_equal(config_data, user_config.all)
+    end
+
+    def test_returns_value_if_key_exists
+      config_file_path = File.expand_path('../fixtures/config.yml', __FILE__)
+      user_config = UserConfig.new(config_file_path)
+      config_data = { 'username' => 'liamseanbrady', 'token' => 'ab12345' }
+
+      assert_equal('ab12345', user_config['token'])
+    end
+
+    def test_returns_nil_if_no_method_exists_for_a_key
+      config_file_path = File.expand_path('../fixtures/config.yml', __FILE__)
+      user_config = UserConfig.new(config_file_path)
+      config_data = { 'username' => 'liamseanbrady', 'token' => 'ab12345' }
+
+      assert_equal(nil, user_config.method_that_does_not_exist)
+    end
+
+    def test_returns_correct_value_if_method_exists_for_a_key
+      config_file_path = File.expand_path('../fixtures/config.yml', __FILE__)
+      user_config = UserConfig.new(config_file_path)
+      config_data = { 'username' => 'liamseanbrady', 'token' => 'ab12345' }
+
+      assert_equal('liamseanbrady', user_config.username)
+    end
+  end
+end

metadata

@@ -0,0 +1,70 @@
+--- !ruby/object:Gem::Specification
+name: gistdoit
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Liam Brady
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-28 00:00:00.000000000 Z
+dependencies: []
+description: An easy way to convert your files to Gists all within the terminal
+email: liamseanbrady+gems@gmail.com
+executables:
+- gistdoit
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- README.md
+- Rakefile
+- bin/gistdoit
+- content.rb
+- gistdoit.gemspec
+- lib/gistdoit.rb
+- lib/gistdoit/cli.rb
+- lib/gistdoit/gist.rb
+- lib/gistdoit/github/client.rb
+- lib/gistdoit/github/user_config.rb
+- lib/gistdoit/net_http_adapter.rb
+- lib/gistdoit/version.rb
+- test/cli_test.rb
+- test/client_test.rb
+- test/command_line_test.rb
+- test/fixtures/create_gist_response
+- test/gist_test.rb
+- test/test_helper.rb
+- test/user_config_test.rb
+homepage: http://github.com/liamseanbrady/gistdoit
+licenses: []
+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.2.2
+signing_key: 
+specification_version: 4
+summary: File to Gist converter
+test_files:
+- test/cli_test.rb
+- test/client_test.rb
+- test/command_line_test.rb
+- test/fixtures/create_gist_response
+- test/gist_test.rb
+- test/test_helper.rb
+- test/user_config_test.rb