github-readme 0.1.0.pre

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 11bacbace0a51057e17a85845d98b9ea192b896d
+  data.tar.gz: 8b7ba7e7619724171a9b4baf9544932de94dd166
+SHA512:
+  metadata.gz: 3d363f96098b0fde3ba46d7b507d68820c3f0b8a67438781f2471344cf94c238a65756617a2d7d0c336d05982a393e4a107bb8734f8dd86bf6c0eee52b3420f0
+  data.tar.gz: 97d7bdfa7501b54428b35bf7f1ff7a511be793fe76f98e1fc2d604f83b121e7f2d6c3156e9b36b9bf014a2576b1b49d8c640d302968e9ba6f4054f4663034a36

data/.gitignore

@@ -0,0 +1,38 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+*-readme.md

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm: 2.2
+install: bundle install
+script: bundle exec github-readme
+after_script: 
+  - bundle exec github-readme dkhamsing/awesome_bot
+  - cat dkhamsing-awesome_bot-readme.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in GitHubReadme.gemspec
+gemspec

data/GitHubReadme.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'github-readme/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = GitHubReadme::PRODUCT
+  spec.version       = GitHubReadme::VERSION
+  spec.authors       = ["dkhamsing"]
+  spec.email         = ["dkhamsing8@gmail.com"]
+
+  spec.summary       = 'Get the README from a GitHub repository'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/dkhamsing/github-readme'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'bin'
+  spec.executables   = [GitHubReadme::PRODUCT]
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'octokit', '~> 4.2.0' # github
+end

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 
+
+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,38 @@
+# github-readme
+
+Get the README from a GitHub repository :octocat:
+
+## Installation
+
+```shell
+$ gem install github-readme --pre
+```
+
+## Usage
+
+### Command Line
+
+```shell
+$ github-readme dkhamsing/awesome_bot
+Gettin README for dkhamsing/awesome_bot ...
+Writing dkhamsing-awesome_bot-readme.md
+```
+
+### Library
+
+```shell
+$ irb
+irb(main):001:0> require 'github-readme'
+=> true
+irb(main):002:0> GitHubReadme::get 'postmates/PMJSON'
+=> {=> {"name"=>"README.md", "readme"=>"# PMJSON\n\n[![Version](https://...", "summary"=>"PMJSON provides a pure-Swift strongly-typed JSON encoder/decoder as well as a set of convenience methods for converting to/from Foundation objects and for decoding JSON structures.", "error"=>nil}
+```
+
+## Contact
+
+- [github.com/dkhamsing](https://github.com/dkhamsing)
+- [twitter.com/dkhamsing](https://twitter.com/dkhamsing)
+
+## License
+
+This project is available under the MIT license. See the [LICENSE](LICENSE) file for more info.

data/Rakefile

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

data/bin/github-readme

@@ -0,0 +1,5 @@
+#!/usr/bin/env ruby
+$LOAD_PATH.push File.expand_path('../../lib', __FILE__)
+
+require 'github-readme'
+GitHubReadme.cli

data/lib/github-readme.rb

@@ -0,0 +1,5 @@
+# Get a GitHub repo README
+require 'github-readme/cli'
+
+module GitHubReadme
+end

data/lib/github-readme/cli.rb

@@ -0,0 +1,40 @@
+# Command line interface
+module GitHubReadme
+  require 'github-readme/version'
+  require 'github-readme/get'
+
+  class << self
+    def cli
+      puts "#{PRODUCT} #{VERSION}"
+
+      if ARGV.count == 0
+        usage
+        exit
+      end
+
+      cli_repo = ARGV[0]
+
+      unless cli_repo.include? '/'
+        usage
+        exit
+      end
+
+      repo = cli_repo.sub 'https://github.com/', ''
+      r = get repo
+
+      e = r['error']
+      unless e.nil?
+        puts "Error: #{e}" unless e.nil?
+        exit 1
+      end
+
+      f = repo.gsub( '/', '-') + '-readme.md'
+      puts "Writing #{f} ⚡️"
+      File.open(f, 'w') { |f| f.write r['readme'] }
+    end
+
+    def usage
+      puts "Usage: #{PRODUCT} <GitHub Repo>"
+    end
+  end
+end

data/lib/github-readme/get.rb

@@ -0,0 +1,72 @@
+# Get the README
+module GitHubReadme
+  require 'octokit'
+
+  class << self
+    def client
+      Octokit
+    end
+
+    def get(repo, client_input = nil)
+      cl =
+        if client_input.nil?
+          client
+        else
+          client_input
+        end
+
+      github cl, repo
+    end
+
+    def github(client, repo)
+      begin
+        r = client.readme repo
+      rescue => e
+        # puts "Error: #{e}"
+        return {
+          'name' => nil,
+          'readme' => nil,
+          'summary' => nil,
+          'error' => e
+        }
+      end
+
+      name = r['name']
+
+      content = r['content']
+      if content.nil?
+        readme = nil
+        summary = nil
+        error = "No README"
+      else
+        readme = Base64.decode64 content unless content.nil?
+        summary = summarize readme
+        error = nil
+      end
+
+      {
+        'name' => name,
+        'readme' => readme,
+        'summary' => summary,
+        'error' => error
+      }
+    end
+
+    def summarize(readme, number_of_lines = 1)
+       return nil if readme.nil?
+
+       separator = "\n"
+       lines = readme.split separator
+       d = []
+       lines[1..-1].each do |l|
+         unless (l.include? '==') || (l.include? '[') || (l.include? '#') || (l.include? '<')
+           d.push l if l.length > 0
+         end
+         break if d.count == number_of_lines
+       end
+
+       d.join separator
+    end
+
+  end
+end

data/lib/github-readme/version.rb

@@ -0,0 +1,5 @@
+module GitHubReadme
+  VERSION = '0.1.0.pre'
+
+  PRODUCT = 'github-readme'
+end

metadata

@@ -0,0 +1,71 @@
+--- !ruby/object:Gem::Specification
+name: github-readme
+version: !ruby/object:Gem::Version
+  version: 0.1.0.pre
+platform: ruby
+authors:
+- dkhamsing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-02-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: octokit
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 4.2.0
+description: Get the README from a GitHub repository
+email:
+- dkhamsing8@gmail.com
+executables:
+- github-readme
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- GitHubReadme.gemspec
+- LICENSE
+- README.md
+- Rakefile
+- bin/github-readme
+- lib/github-readme.rb
+- lib/github-readme/cli.rb
+- lib/github-readme/get.rb
+- lib/github-readme/version.rb
+homepage: https://github.com/dkhamsing/github-readme
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.14
+signing_key: 
+specification_version: 4
+summary: Get the README from a GitHub repository
+test_files: []