grepg 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: e6f1d0a10e8d070997d8bb6766fdcc1e63225f28
+  data.tar.gz: c47a93c984efa2809b2f855d3d1647eb3dccbac7
+SHA512:
+  metadata.gz: ccbe4d8835cd16ee0af1471793339a4d718cd67ceeef56a444e987557daac9133bf3971cc430aae771a92d648097062bb57e7e205d3a685f5fdbf6874f96dbd2
+  data.tar.gz: bfff67002c982ea130a1fb1b92a2e748c488f863e8f730427ad630e230d61dc5fc859b69f51773c05c4e7216766744b2e264046844af51add842ea018be1d6d8

data/.gitignore

@@ -0,0 +1,2 @@
+pkg/
+*.swp

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://www.rubygems.org'
+
+gem 'rake', '~> 10.1.0'
+gem 'trollop', '~> 2.1.2'
+gem 'rest-client', '~> 1.8.0'
+gem 'colorize', '~> 0.7.7'
+
+group :development do
+  gem 'rspec', :require => 'spec'
+  gem 'webmock', '~> 1.21.0'
+end

data/Gemfile.lock

@@ -0,0 +1,54 @@
+GEM
+  remote: https://www.rubygems.org/
+  specs:
+    addressable (2.4.0)
+    colorize (0.7.7)
+    crack (0.4.3)
+      safe_yaml (~> 1.0.0)
+    diff-lcs (1.2.5)
+    domain_name (0.5.20160310)
+      unf (>= 0.0.5, < 1.0.0)
+    http-cookie (1.0.2)
+      domain_name (~> 0.5)
+    mime-types (2.99)
+    netrc (0.11.0)
+    rake (10.1.1)
+    rest-client (1.8.0)
+      http-cookie (>= 1.0.2, < 2.0)
+      mime-types (>= 1.16, < 3.0)
+      netrc (~> 0.7)
+    rspec (3.4.0)
+      rspec-core (~> 3.4.0)
+      rspec-expectations (~> 3.4.0)
+      rspec-mocks (~> 3.4.0)
+    rspec-core (3.4.4)
+      rspec-support (~> 3.4.0)
+    rspec-expectations (3.4.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-mocks (3.4.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.4.0)
+    rspec-support (3.4.1)
+    safe_yaml (1.0.4)
+    trollop (2.1.2)
+    unf (0.1.4)
+      unf_ext
+    unf_ext (0.0.7.2)
+    webmock (1.21.0)
+      addressable (>= 2.3.6)
+      crack (>= 0.3.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  colorize (~> 0.7.7)
+  rake (~> 10.1.0)
+  rest-client (~> 1.8.0)
+  rspec
+  trollop (~> 2.1.2)
+  webmock (~> 1.21.0)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -0,0 +1,54 @@
+#grepg
+###The ruby client for greppage
+
+`grepg` (pronounced Grep G) is a ruby client for [GrepPage](https://www.greppage.com).  It is packaged as a gem.
+
+###Install
+To install `grepg` run ```gem install grepg```
+
+###Examples
+```
+Usage:
+grepg user_name topic_name [-s search_term]
+```
+
+Get all items/microdoc for a topic on any collection.
+
+```
+$ grepg kdavis git
+User: kdavis, Topic: git
+push tags to remote / Github
+git push --tags
+
+remove delete tag
+git tag -d v0.0.8
+
+list branches that have not been merged
+git branch --no-merged
+
+list branches merged into master
+git branch --merged master
+...
+
+```
+
+Search for a specific string
+
+```
+$ grepg kdavis git -s stash
+User: kdavis, Topic: git, Search-Term: stash
+TO apply your changes
+git stash --apply
+
+To list the stash
+git stash list
+
+Git stash
+git stash
+```
+
+##Development
+To run tests run ```bundle exec rake spec```. To install the gem locally, first build it using ```bundle exec rake build```. Then install the gem ```gem install pkg/grepg-0.0.1.gem```
+
+##License
+grepg is under the [MIT License](http://www.opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,11 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+$:.unshift('lib')
+
+RSpec::Core::RakeTask.new(:spec) do |t|
+    t.rspec_opts = ["-c", "-f progress", "-r ./spec/spec_helper.rb"]
+    t.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec

data/bin/grepg

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+require 'grepg'
+
+GrepPage::Parser.new(ARGV).run!

data/grepg.gemspec

@@ -0,0 +1,22 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require_relative 'lib/grepg/version'
+
+Gem::Specification.new do |s|
+  s.name        = "grepg"
+  s.version     = GrepPage::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Yash Ranadive"]
+  s.email       = ["yash.ranadive@gmail.com"]
+  s.homepage    = "https://www.greppage.com"
+  s.summary     = %q{A ruby client to access greppage.com from the commandline}
+  s.description = %q{A ruby client to access greppage.com from the commandline}
+
+  s.add_development_dependency "rspec", "~>3.0.0"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- spec/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end
+

data/lib/grepg/api.rb

@@ -0,0 +1,34 @@
+require 'rest-client'
+
+module GrepPage
+  module API
+    BASE_URL = 'https://www.greppage.com/api'
+    ACCESS_TOKEN = 'Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiIsImFsZyI6IkhTMjU2IiwidHlwIjoiSldUIn0.eyJpZCI6MjAwMDAwMDAwMCwiZW1haWwiOiJndWVzdEBndWVzdC5jb20iLCJuYW1lIjoiZ3Vlc3QiLCJleHAiOjE1MTExMzY4MzB9.gWohR7LLtROgjSl5SxbEaGRBveZQEv7Uj2rzmgYrbys'
+    def self.get(uri, access_token = ACCESS_TOKEN)
+      RestClient.get uri, {:accept => :json, :authorization => access_token}
+    end
+
+    def self.sheets(user_name)
+      response = get(sheets_uri(user_name))
+      raise RunTimeException if response.code != 200
+
+      JSON.parse(response.to_str, symbolize_names: true)
+    end
+
+    def self.cheats(user_name, sheet_id)
+      response = get(cheats_uri(user_name, sheet_id))
+      raise Exception if response.code != 200
+
+      JSON.parse(response.to_str, symbolize_names: true)
+    end
+
+    def self.sheets_uri(user_name)
+      [BASE_URL, 'users', user_name, 'sheets_with_stats'].join('/')
+    end
+
+    def self.cheats_uri(user_name, sheet_id)
+      [BASE_URL, 'users', user_name, 'sheets', sheet_id, 'cheats'].join('/')
+    end
+  end
+end
+

data/lib/grepg/formatter.rb

@@ -0,0 +1,13 @@
+require 'colorize'
+module GrepPage
+  class Formatter
+    # Displays an array of cheats
+    def self.cheat_rows(cheats, search_term)
+      cheats.map do |cheat|
+        puts cheat[:description].colorize(:green)
+        puts cheat[:command].colorize(:blue)
+        puts
+      end
+    end
+  end
+end

data/lib/grepg/parser.rb

@@ -0,0 +1,82 @@
+require 'trollop'
+require 'rest-client'
+
+# This class parses commandline arguments
+module GrepPage
+  class Parser
+    def initialize(args)
+      parser = Trollop::Parser.new do
+        opt :search,
+          "text to search",
+          :type => :string,
+          :required => false,
+          :short => "-s"
+        banner <<-EOS
+
+Usage:
+  grepg user_name topic_name [-s search_term]
+
+Examples:
+  grepg kdavis css
+  greppg kdavis css -s color
+        EOS
+      end
+
+      @opts = Trollop::with_standard_exception_handling parser do
+        raise Trollop::HelpNeeded if args.size < 2 # show help screen
+        parser.parse args
+      end
+
+      leftovers = parser.leftovers
+      @user = leftovers.shift
+      @topic = leftovers.shift
+      @search_term = @opts[:search]
+    end
+
+    def get_all_topics(user)
+      GrepPage::API.sheets(user)
+    end
+
+    def filter_topics(topics, topic_name = '')
+      sheet = topics.select{|topic| topic[:name].downcase == topic_name.downcase}.first
+      sheet = topics.select{|topic| topic[:name].downcase[topic_name.downcase]}.first unless sheet
+      sheet
+    end
+
+    def get_cheats(user, sheet_id)
+      GrepPage::API.cheats(user, sheet_id)
+    end
+
+    def filter_cheats(cheats, search_term)
+      cheats.select do |cheat|
+        (cheat[:description].downcase[@search_term.downcase] ||
+         cheat[:command].downcase[@search_term.downcase]) != nil
+      end
+    end
+
+    def run!
+      headers = ["User: #{@user}", "Topic: #{@topic}"]
+      headers << "Search-Term: #{@search_term}" if @search_term
+      puts headers.join(", ")
+
+      begin
+        topics = get_all_topics(@user)
+      rescue RestClient::ResourceNotFound => ex
+        puts "That username does not exist"
+        exit 1
+      end
+
+      topic = filter_topics(topics, @topic)
+      if topic.nil? || topic.empty?
+        puts "Can't find that topic. Choose one of the following"
+        puts topics.map{|topic| topic[:name]}
+        exit 1
+      end
+
+      cheats = get_cheats(@user, topic[:id])
+      cheats = filter_cheats(cheats, @search_term) if @search_term
+
+      GrepPage::Formatter.cheat_rows(cheats, @search_term)
+    end
+  end
+end

data/lib/grepg/version.rb

@@ -0,0 +1,3 @@
+module GrepPage
+  VERSION = "0.0.2"
+end

data/lib/grepg.rb

@@ -0,0 +1,3 @@
+require 'grepg/api'
+require 'grepg/parser'
+require 'grepg/formatter'

data/spec/grepg/api_spec.rb

@@ -0,0 +1,37 @@
+require 'json'
+require_relative '../../lib/grepg.rb'
+
+describe GrepPage::API do
+  let(:user_name) {TEST_USER}
+  let(:sheet_id) {TEST_SHEET_ID}
+
+  context "Sheet Fetching" do
+    let(:api) {GrepPage::API}
+    it "checks for a JSON array" do
+      sheets = api.sheets(user_name)
+      expect(sheets.class).to eq(Array)
+    end
+
+    it "checks for name and id field in each sheet" do
+      sheets = api.sheets(user_name)
+      expect(sheets.first[:name]).to be_truthy
+      expect(sheets.first[:id]).to be_truthy
+    end
+  end
+
+  context "Cheats Fetching" do
+    let(:api) {GrepPage::API}
+    it "checks for a JSON array" do
+      sheets = api.cheats(user_name, sheet_id)
+      expect(sheets.class).to eq(Array)
+    end
+
+    it "checks for name and id field in each cheat" do
+      sheets = api.cheats(user_name, sheet_id)
+      expect(sheets.first[:command]).to be_truthy
+      expect(sheets.first[:description]).to be_truthy
+    end
+  end
+end
+
+

data/spec/grepg/parser_spec.rb

@@ -0,0 +1,22 @@
+require 'json'
+require_relative '../../lib/grepg.rb'
+
+describe GrepPage::Parser do
+  describe '.initialize' do
+    context "expected behavior" do
+      it "returns a set of cheats when username and topic are given" do
+        parser = GrepPage::Parser.new(['kdavis', 'css'])
+        output = capture_stdout { parser.run! }
+        expect(output).to match(/colors/)
+      end
+
+      it "returns a set of cheats when username, topic and search term are given" do
+        parser = GrepPage::Parser.new(['kdavis', 'css', '-s', 'colors'])
+        output = capture_stdout { parser.run! }
+        expect(output).to match(/colors/)
+      end
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,52 @@
+require 'webmock/rspec'
+# This should almost always remain true. We should test locally
+TEST_LOCALLY = true
+# The user whose cheats we will access
+TEST_USER = 'kdavis'
+# The sheet_id of the test user
+TEST_SHEET_ID = '68'
+# Disable outgoing network connections
+TEST_LOCALLY ? WebMock.disable_net_connect! : WebMock::allow_net_connect!
+
+# TODO: This is probably not a good place to put the stubbing logic
+RSpec.configure do |config|
+  config.before(:each) do
+    if(TEST_LOCALLY)
+      configure_sheets_endpoint
+      configure_cheats_endpoint
+    end
+  end
+
+  def configure_sheets_endpoint
+    access_token = GrepPage::API::ACCESS_TOKEN
+
+    # Assuming that these are the responses returned by the API
+    sheets_body = %Q[
+     [{"id":68,"name":"CSS","user_id":18,"created_at":"2016-03-16T11:46:27-07:00","updated_at":"2016-03-16T11:46:27-07:00"},{"id":69,"name":"ES6","user_id":18,"created_at":"2016-03-16T11:49:30-07:00","updated_at":"2016-03-16T11:49:30-07:00"},{"id":70,"name":"UNIX","user_id":18,"created_at":"2016-03-16T11:55:25-07:00","updated_at":"2016-03-16T11:55:25-07:00"},{"id":71,"name":"GIT","user_id":18,"created_at":"2016-03-16T12:25:25-07:00","updated_at":"2016-03-16T12:25:25-07:00"}]
+    ].strip
+    stub_request(:get, "https://www.greppage.com/api/users/#{TEST_USER}/sheets_with_stats").
+      with(:headers => {"Authorization" => GrepPage::API::ACCESS_TOKEN}).
+      to_return(status: 200, body: sheets_body, headers: {})
+  end
+
+  def configure_cheats_endpoint
+    # Assuming that these are the responses returned by the API
+    cheats_body = %Q[
+      [{"id":718,"description":"color palette for web safe colors","command":"http://0xrgb.com/#flat","sheet_id":1,"created_at":"2015-12-19T12:55:19-08:00","updated_at":"2015-12-19T12:55:19-08:00"},{"id":728,"description":"Bootstrap text formatting styles","command":"http://www.w3schools.com/bootstrap/bootstrap_ref_css_text.asp","sheet_id":1,"created_at":"2015-12-29T21:16:34-08:00","updated_at":"2015-12-29T21:16:34-08:00"}]
+    ].strip
+    stub_request(:get, "https://www.greppage.com/api/users/#{TEST_USER}/sheets/#{TEST_SHEET_ID}/cheats").
+      with(:headers => {"Authorization" => GrepPage::API::ACCESS_TOKEN}).
+      to_return(status: 200, body: cheats_body, headers: {})
+  end
+end
+
+def capture_stdout(&block)
+  original_stdout = $stdout
+  $stdout = fake = StringIO.new
+  begin
+    yield
+  ensure
+    $stdout = original_stdout
+  end
+  fake.string
+end

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: grepg
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Yash Ranadive
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: A ruby client to access greppage.com from the commandline
+email:
+- yash.ranadive@gmail.com
+executables:
+- grepg
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- bin/grepg
+- grepg.gemspec
+- lib/grepg.rb
+- lib/grepg/api.rb
+- lib/grepg/formatter.rb
+- lib/grepg/parser.rb
+- lib/grepg/version.rb
+- spec/grepg/api_spec.rb
+- spec/grepg/parser_spec.rb
+- spec/spec_helper.rb
+homepage: https://www.greppage.com
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: A ruby client to access greppage.com from the commandline
+test_files:
+- spec/grepg/api_spec.rb
+- spec/grepg/parser_spec.rb
+- spec/spec_helper.rb