tldrb 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: bbe243753aab8a748547f3537b3a4ff9f98e048a
+  data.tar.gz: 49320da1b677795d437bb991694ccbbd90b7cd14
+SHA512:
+  metadata.gz: 88d977f468481b90431cb3fa689379aabc79c00f629bf21c5753628ba3a98db462a441c5113fda6ef6e4948b99dc161e7d05ac521139246c5e83f713732dccb3
+  data.tar.gz: b4dc7bbadb89ff7a90aae77539f0246a8921c55c92e0116d5f92aa885563501c43767ef879ffa469323dab096f65d9346f6557d2cd7266d163d97822fe594f68

data/COPYING

@@ -0,0 +1,20 @@
+Copyright (c) 2015 Ryan S. Northrup
+
+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,17 @@
+# tldrb
+
+> Ruby client for [tldr](https://github.com/tldr-pages/tldr), built
+  with [Ruby on Bales](https://github.com/YellowApple/bales).
+  MIT-licensed.
+
+- Install
+
+`gem install tldrb`
+
+- Get a tldr for "foo"
+
+`tldrb foo`
+
+- Get a tldr for "foo" on a specific OS ['linux', 'sunos', 'osx']
+
+`tldrb foo -o osx`

data/bin/tldrb

@@ -0,0 +1,69 @@
+#!/usr/bin/env ruby
+
+require 'bales'
+require 'rest-client'
+
+module Tldrb; end
+
+module Tldrb::Functions
+  def get_page(query, platform)
+    url = "https://raw.github.com/tldr-pages/tldr/master/pages/" \
+          "#{platform}/#{query}.md"
+    response = RestClient.get url
+
+    response.to_str
+  rescue RestClient::Exception
+    nil
+  end
+
+  def my_platform
+    platform = Gem::Platform.local.os
+    # TODO: suggest upstream use of "darwin" instead of "osx", since
+    # "darwin" is what is actually used by OS X internally"
+    platform = 'osx' if platform == 'darwin'
+    return platform
+  end
+
+  def supported_platforms
+    # TODO: check for supported platforms dynamically
+    ['linux', 'osx', 'sunos']
+  end
+end
+
+class Tldrb::Application < Bales::Application
+  version "0.0.1"
+  summary "tldr client in Ruby"
+  description "Ruby client for tldr " \
+              "(<https://github.com/tldr-pages/tldr>).  Implemented with " \
+              "the Ruby on Bales command-line app framework " \
+              "(<https://github.com/YellowApple/bales>)."
+
+  # TODO: implement opt value checking in Bales
+  option :platform,
+         short_form: '-o',
+         long_form: '--os',
+         type: String,
+         description: "Override the operating system [linux, osx, sunos]"
+
+  action do |query, platform: nil|
+    unless query.class == String
+      Tldrb::Command::Help.run
+      return
+    end
+    extend Tldrb::Functions
+
+    platform = my_platform if platform.nil?
+
+    result = get_page query, platform
+    result = get_page query, 'common' if result.nil?
+
+    if result.nil?
+      puts "Couldn't find a tldr for '#{query}'."
+    else
+      # TODO: markdown formatting
+      puts result
+    end
+  end
+
+  parse_and_run
+end

metadata

@@ -0,0 +1,83 @@
+--- !ruby/object:Gem::Specification
+name: tldrb
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ryan S. Northrup
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-08-08 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bales
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.3
+- !ruby/object:Gem::Dependency
+  name: rest-client
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+description: Ruby client for tldr (<https://github.com/tldr-pages/tldr>).  Implemented
+  with the Ruby on Bales command-line app framework (<https://github.com/YellowApple/bales>).
+email:
+- rnorthrup@newleaders.com
+executables:
+- tldrb
+extensions: []
+extra_rdoc_files: []
+files:
+- COPYING
+- README.md
+- bin/tldrb
+homepage: https://github.com/YellowApple/tldrb
+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.6
+signing_key: 
+specification_version: 4
+summary: tldr client in Ruby
+test_files: []