theysaidsocli 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 1120aa346e6dc574e5f539c15571ef3fadef2d511baaaae3d5005a709762364d
+  data.tar.gz: af74bcbbd2a75b91c268d3fb5377b0c2098d00650696dd228a0a6e1d761e81e8
+SHA512:
+  metadata.gz: 822e9ec2d6e317791887514c1c187990915c89665ec508fbdc68ce06aa17131670fca87d2faec96049b2006b61495db72df0fc608415de13f0c909bf6e5db91a
+  data.tar.gz: af622cf44f7de608ba5c654508af629a5789ced4f5423ca662483effb46d0da1a20a6cc06066a19e42a80d4a77c59680786c6afc9690a15ebc66e8faa0fcc578

data/.gitignore

@@ -0,0 +1,13 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+.idea/*

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.17.1

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,77 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at tzi.sof@gmail.com
+
+
+. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,12 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+require "bundler/setup"
+
+
+# Specify your gem's dependencies in theysaidsocli.gemspec
+gemspec
+
+gem "httparty"
+gem "hirb"

data/Gemfile.lock

@@ -0,0 +1,45 @@
+PATH
+  remote: .
+  specs:
+    theysaidsocli (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.3)
+    hirb (0.7.3)
+    httparty (0.16.4)
+      mime-types (~> 3.0)
+      multi_xml (>= 0.5.2)
+    mime-types (3.2.2)
+      mime-types-data (~> 3.2015)
+    mime-types-data (3.2018.0812)
+    multi_xml (0.6.0)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.17)
+  hirb
+  httparty
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  theysaidsocli!
+
+BUNDLED WITH
+   1.17.1

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 sofia
+
+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,58 @@
+# theysaidso
+
+Powered by:
+<span style="z-index:50;font-size:0.9em;"><img src="https://theysaidso.com/branding/theysaidso.png" height="20" width="20" alt="theysaidso.com"/><a href="https://theysaidso.com" title="Powered by quotes from theysaidso.com" style="color: #9fcc25; margin-left: 4px; vertical-align: middle;">theysaidso.com</a></span>
+
+
+This is a simple CLI gem to get quotes from the TheysaidsocliAPI.
+If you need some inspiration during your day, just pick your daily quote from your command line!
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'theysaidsocli'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install theysaidso
+
+## Usage
+
+You can run in your command line:
+
+- `theysaidso` : gets you the Quote of the day!
+- `Theysaidsocli-cat` : gets you all the available quote categories
+- `Theysaidsocli-cat life` : gets you a quote from the "life" category
+
+
+### TODO:
+
+The API is rate-limited so with the free version you can make 10requests per hour.
+I doubt people will need more than that in a CLI, but I will implement at some point passing an API key to get unlimited quotes
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/theysaidso. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Theysaidsocliproject’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/theysaidso/blob/master/CODE_OF_CONDUCT.md).
+
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "theysaidsocli"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/bin/theysaidsocli

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+require "theysaidsocli"
+require "quote_terminal_printer"
+require "theysaidsocli/version"
+
+quote_fetcher = QuoteFetcher.new
+
+entered_ARGV = ARGV.length > 0;
+
+begin
+    unless entered_ARGV
+        qod = quote_fetcher.qod
+        QuoteTerminalPrinter.new(qod).print
+        return
+    end
+
+    case ARGV[0]
+
+        when "-v"
+            puts Theysaidsocli::VERSION
+        when "-h"
+            puts "Hello! Welcome to the help menu of the TheySaySo cli."
+            puts "  -v         | Get version"
+            puts "             | Get the quote of the day"
+            puts "  -cat       | Get all categories"
+            puts "  -cat <Cat> | Pick a quote from a specific category"
+            exit
+        when "-cat"
+
+            if ARGV[1]
+                qod = quote_fetcher.qod(ARGV[1])
+                QuoteTerminalPrinter.new(qod).print
+                return
+            end
+
+            categories = quote_fetcher.categories
+            puts "Available categories:"
+            categories.each { |c| puts c.to_s }
+        else
+            puts "Unknown option. Use theysaidsocli -h for help."
+        end
+
+rescue RateLimitError
+    puts "You are making too many requests... Try again in an hour."
+rescue NotFoundError
+    puts "No results were found with the term used. Try again with a different term.."
+end
+
+

data/lib/category.rb

@@ -0,0 +1,14 @@
+class Category
+
+  attr_accessor :key, :description
+
+  def initialize(key, description)
+    @key = key
+    @description = description
+  end
+
+  def to_s
+    "#{@key}: '#{@description}'"
+  end
+
+end

data/lib/quote.rb

@@ -0,0 +1,15 @@
+class Quote
+
+  attr_accessor :author, :quote, :length, :tags, :category, :date
+
+  def initialize(quote_hash)
+    @author = quote_hash[:author]
+    @quote = quote_hash[:quote]
+    @length = quote_hash[:length]
+    @tags = quote_hash[:tags]
+    @category = quote_hash[:category]
+    @date = quote_hash[:date]
+  end
+
+
+end

data/lib/quote_terminal_printer.rb

@@ -0,0 +1,37 @@
+require 'hirb'
+
+class QuoteTerminalPrinter
+
+  def initialize(quote)
+    @quote = quote
+    @print_text = "#{@quote.author} said: \"#{@quote.quote}\""
+    @width = @print_text.size
+  end
+
+  def print
+    puts
+    print_separator
+    print_quote
+    print_separator
+    puts
+  end
+
+  private
+
+  def print_quote
+    puts "~ #{@print_text} ~"
+  end
+
+  def print_separator
+    puts "*" * separator_width
+  end
+
+  def separator_width
+    [@width + 4, terminal_width].min
+  end
+
+  def terminal_width
+    Hirb::Util.detect_terminal_size[0]
+  end
+
+end

data/lib/response.rb

@@ -0,0 +1,26 @@
+class Response
+
+  attr_accessor :content
+
+  def initialize(http_response)
+    @status = http_response.response.code
+    @content = parse_contents(http_response)
+  end
+
+  def rate_limited?
+    @status == "429"
+  end
+
+  def success?
+    @status == "200" && !@content.nil?
+  end
+
+  private
+
+  def parse_contents(response)
+    stringify_response = response.to_s
+    json_object = JSON.parse(stringify_response, :symbolize_names => true)
+    json_object[:contents]
+  end
+
+end

data/lib/theysaidsocli.rb

@@ -0,0 +1,48 @@
+require_relative "theysaidsocli/version"
+require_relative "quote"
+require_relative "response"
+require_relative "category"
+require "httparty"
+
+class RateLimitError < StandardError; end
+class NotFoundError < StandardError; end
+
+class QuoteFetcher
+
+  QOD_URL = "http://quotes.rest/qod.json"
+  QOD_URL_WITH_CATEGORY = "http://quotes.rest/qod.json?category="
+  CATEGORIES_URL = "http://quotes.rest/qod/categories.json"
+
+  def categories
+    categories_response = HTTParty.get(CATEGORIES_URL)
+
+    response = Response.new(categories_response)
+    raise RateLimitError if response.rate_limited?
+    raise NotFoundError unless response.success?
+
+    categories = []
+    response.content[:categories].each do |key, value|
+      categories << Category.new(key, value)
+    end
+    categories
+  end
+
+  def qod(category = nil)
+    sanitized_category = sanitize_input(category)
+    qod_response = HTTParty.get(sanitized_category ? "#{QOD_URL_WITH_CATEGORY}#{sanitized_category}" : QOD_URL)
+
+    response = Response.new(qod_response)
+    raise RateLimitError if response.rate_limited?
+    raise NotFoundError unless response.success?
+
+    Quote.new(response.content[:quotes][0])
+  end
+
+  private
+
+  def sanitize_input(category)
+    return nil if category.nil?
+    category.gsub(/[^0-9A-Za-z]/,'')
+  end
+
+end

data/lib/theysaidsocli/version.rb

@@ -0,0 +1,3 @@
+module Theysaidsocli
+  VERSION = "0.2.0"
+end

data/theysaidsocli.gemspec

@@ -0,0 +1,45 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "theysaidsocli/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "theysaidsocli"
+  spec.version       = Theysaidsocli::VERSION
+  spec.authors       = ["@Sofia"]
+  spec.email         = ["tzi.sof@gmail.com\n\n\n"]
+
+  spec.summary       = %q{CLI tool to give you random quotes.}
+  spec.description   = %q{Gets you random quotes from the TheysaidsocliAPI.}
+  spec.homepage      = "https://github.com/siwS/theysaidsocli"
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/siwS/theysaidsocli"
+    spec.metadata["changelog_uri"] = "https://github.com/siwS/theysaidsocli"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.executables   = ["theysaidsocli"]
+  spec.require_paths = ["lib"]
+  spec.bindir        = "bin"
+
+  spec.add_runtime_dependency 'httparty'
+  spec.add_runtime_dependency 'hirb'
+
+  spec.add_development_dependency 'httparty'
+  spec.add_development_dependency 'hirb'
+  spec.add_development_dependency "bundler", "~> 1.17"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: theysaidsocli
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- "@Sofia"
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-03-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: hirb
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.17'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: Gets you random quotes from the TheysaidsocliAPI.
+email:
+- |+
+  tzi.sof@gmail.com
+
+
+executables:
+- theysaidsocli
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/theysaidsocli
+- lib/category.rb
+- lib/quote.rb
+- lib/quote_terminal_printer.rb
+- lib/response.rb
+- lib/theysaidsocli.rb
+- lib/theysaidsocli/version.rb
+- theysaidsocli.gemspec
+homepage: https://github.com/siwS/theysaidsocli
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org
+  homepage_uri: https://github.com/siwS/theysaidsocli
+  source_code_uri: https://github.com/siwS/theysaidsocli
+  changelog_uri: https://github.com/siwS/theysaidsocli
+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.7.6
+signing_key: 
+specification_version: 4
+summary: CLI tool to give you random quotes.
+test_files: []