bored 0.0.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5579caaa49fedb5fe996b66acbeabccb47387bdce42cfce16f121e7175096ae1
-  data.tar.gz: fdc513c3ada2f1a8345852b032914d3a0f67e36764bba75758688c2c8d4776c1
+  metadata.gz: de2d7fa98a1ff3d173796e4595aea035f4a83adbb84b669db7edef52a48b2076
+  data.tar.gz: '089964fa3b1e46297afd7409ea9e19090a8f1734623ce7234e24feae2c4a0012'
 SHA512:
-  metadata.gz: cc8222915fbf3a2959f17f07033f1752099fcd86d0a427d9dd827cb22d3ee492a927dd5cf345b9dc6a1d5d2d94f3bcbea4a8bdaf644570c23aabfdbbed0975e6
-  data.tar.gz: f5cc6dd832b40ee2f3e20f93b1ce2095215bd752b612f8f1498e4fc454b4e831c3e1ce6e89183016cabc59ef2d48ccafeeb314d3244a76b754549854d66a4a6a
+  metadata.gz: 418912a5b8aaa4882be648875c3fb0baa4a6a21ba01bbf6030539fde1a40330358deda9fcae1edf8a13ee2252704b82feb7be353ca80c1a08322dbfa2535f37f
+  data.tar.gz: 7fa02e633472a344f6d01aca1fe83746c7d674caa6a7e528f8d99da023f473bbaef364bdffba709a86d1500f2f118fd550f4bb8b36aef70de7c0dac82e0e4157

data/.standard.yml

@@ -1,4 +1,3 @@
 # For available configuration options, see:
 #   https://github.com/testdouble/standard
 
-default_ignores: false

data/CHANGELOG.md

@@ -1,5 +1,26 @@
 ## [Unreleased]
 
+## [0.2.0] - 2022-05-19
+
+- Add `--type` filter option in the CLI
+  [#15](https://github.com/testdouble/bored/pull/15) by
+  [@radglob](https://github.com/radglob) and
+  [@BrianBorge](@https://github.com/BrianBorge)
+
+## [0.1.0] - 2021-12-02
+
+- Add filtering by Activity ID
+  [#12](https://github.com/testdouble/bored/pull/12) by
+  [@lsparlin](https://github.com/lsparlin)
+
+- Add filtering by participant count
+  [#14](https://github.com/testdouble/bored/pull/14) by
+  [@jonathanpike](https://github.com/jonathanpike)
+
+## [0.0.2] - 2021-11-09
+
+- Add `bored` CLI
+
 ## [0.0.1] - 2021-11-08
 
 - Add Bored.now() method, returning an activity

data/Gemfile

@@ -1,12 +1,9 @@
-# frozen_string_literal: true
-
 source "https://rubygems.org"
 
 # Specify your gem's dependencies in bored.gemspec
 gemspec
 
-gem "rake", "~> 13.0"
-
-gem "minitest", "~> 5.0"
-
-gem "standard", "~> 1.3"
+gem "rake"
+gem "minitest"
+gem "standard"
+gem "pry"

data/Gemfile.lock

@@ -1,16 +1,21 @@
 PATH
   remote: .
   specs:
-    bored (0.0.1)
+    bored (0.2.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
     ast (2.4.2)
+    coderay (1.1.3)
+    method_source (1.0.0)
     minitest (5.14.4)
     parallel (1.21.0)
     parser (3.0.2.0)
       ast (~> 2.4.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
     rainbow (3.0.0)
     rake (13.0.6)
     regexp_parser (2.1.1)
@@ -37,12 +42,15 @@ GEM
 
 PLATFORMS
   arm64-darwin-20
+  arm64-darwin-21
+  x86_64-linux
 
 DEPENDENCIES
   bored!
-  minitest (~> 5.0)
-  rake (~> 13.0)
-  standard (~> 1.3)
+  minitest
+  pry
+  rake
+  standard
 
 BUNDLED WITH
-   2.3.0.dev
+   2.3.14

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2021 Justin Searls
+Copyright (c) 2021 Test Double Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,43 +1,49 @@
 # Bored
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/bored`. To experiment with that code, run `bin/console` for an interactive prompt.
+This is a simple example gem developed for the conference talk ["How to make a
+gem of a gem"](https://rubyconf.org/program/sessions#session-1203) at
+[RubyConf](https://rubyconf.org) 2021.
 
-TODO: Delete this and the text above, and describe your gem
+The Bored gem calls the [Bored API](https://www.boredapi.com) and returns random
+activity ideas.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+The installation process is boring, but familiar!
 
 ```ruby
-gem 'bored'
+$ gem install bored
 ```
 
-And then execute:
-
-    $ bundle install
-
-Or install it yourself as:
-
-    $ gem install bored
-
 ## Usage
 
-TODO: Write usage instructions here
+### CLI
 
-## Development
+Once installed, run:
 
-After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+```
+$ bored
+```
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+And an activity will be printed. That's it!
 
-## Contributing
+### API
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/searls/bored. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/searls/bored/blob/main/CODE_OF_CONDUCT.md).
+To invoke the gem programmatically, just call:
 
-## License
+```ruby
+Bored.now
+```
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+This will return an
+[Activity](https://github.com/testdouble/bored/blob/main/lib/bored.rb#L11-L15)
+object.
 
 ## Code of Conduct
 
-Everyone interacting in the Bored project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/searls/bored/blob/main/CODE_OF_CONDUCT.md).
+This project follows Test Double's [code of
+conduct](https://testdouble.com/code-of-conduct) for all community interactions,
+including (but not limited to) one-on-one communications, public posts/comments,
+code reviews, pull requests, and GitHub issues. If violations occur, Test Double
+will take any action they deem appropriate for the infraction, up to and
+including blocking a user from the organization's repositories.

data/Rakefile

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require "bundler/gem_tasks"
 require "rake/testtask"
 

data/bin/console

@@ -1,5 +1,4 @@
 #!/usr/bin/env ruby
-# frozen_string_literal: true
 
 require "bundler/setup"
 require "bored"

data/bored.gemspec

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 require_relative "lib/bored/version"
 
 Gem::Specification.new do |spec|

data/exe/bored

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{__dir__}/../lib")
+
+require "bored"
+
+Bored::Cli.new(ARGV).run

data/lib/bored/cli.rb

@@ -0,0 +1,25 @@
+require "optparse"
+
+module Bored
+  class Cli
+    def initialize(argv)
+      @argv = argv
+    end
+
+    def run
+      puts Bored.now(**params).description
+    end
+
+    private
+
+    def params
+      options = {}
+      OptionParser.new do |opts|
+        opts.on("--type TYPE", "Pick the type of activity") do |t|
+          options[:type] = t
+        end
+      end.parse!
+      options
+    end
+  end
+end

data/lib/bored/version.rb

@@ -1,5 +1,3 @@
-# frozen_string_literal: true
-
 module Bored
-  VERSION = "0.0.1"
+  VERSION = "0.2.0"
 end

data/lib/bored.rb

@@ -1,8 +1,7 @@
-# frozen_string_literal: true
-
 require "net/http"
 require "json"
 require_relative "bored/version"
+require_relative "bored/cli"
 
 module Bored
   class Error < StandardError; end
@@ -13,18 +12,29 @@ module Bored
     keyword_init: true
   )
 
-  def self.now
-    json = JSON.parse(Net::HTTP.get(
-      "www.boredapi.com", "/api/activity"
-    ))
-    Activity.new(
-      id: json["key"].to_i,
-      description: json["activity"],
-      type: json["type"].to_sym,
-      participants: json["participants"],
-      accessibility: json["accessibility"],
-      price: json["price"],
-      link: json["link"].empty? ? nil : json["link"]
-    )
+  class << self
+    def now(params = {})
+      json = JSON.parse(Net::HTTP.get(uri(params)))
+      raise Error.new(json["error"]) if json["error"]
+
+      Activity.new(
+        id: json["key"].to_i,
+        description: json["activity"],
+        type: json["type"].to_sym,
+        participants: json["participants"],
+        accessibility: json["accessibility"],
+        price: json["price"],
+        link: json["link"].empty? ? nil : json["link"]
+      )
+    end
+
+    private
+
+    def uri(params)
+      uri = URI("https://www.boredapi.com/api/activity")
+      uri.query = URI.encode_www_form(params.compact)
+
+      uri
+    end
   end
 end

metadata

@@ -1,25 +1,25 @@
 --- !ruby/object:Gem::Specification
 name: bored
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Justin Searls
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-20 00:00:00.000000000 Z
+date: 2022-05-19 00:00:00.000000000 Z
 dependencies: []
 description:
 email:
 - searls@gmail.com
-executables: []
+executables:
+- bored
 extensions: []
 extra_rdoc_files: []
 files:
 - ".standard.yml"
 - CHANGELOG.md
-- CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
 - LICENSE.txt
@@ -28,7 +28,9 @@ files:
 - bin/console
 - bin/setup
 - bored.gemspec
+- exe/bored
 - lib/bored.rb
+- lib/bored/cli.rb
 - lib/bored/version.rb
 homepage: https://github.com/testdouble/bored
 licenses:
@@ -52,7 +54,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.29
+rubygems_version: 3.3.6
 signing_key:
 specification_version: 4
 summary: Gives you ideas of stuff to do when you're bored

data/CODE_OF_CONDUCT.md

@@ -1,84 +0,0 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
-
-We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
-
-## Our Standards
-
-Examples of behavior that contributes to a positive environment for our community include:
-
-* Demonstrating empathy and kindness toward other people
-* Being respectful of differing opinions, viewpoints, and experiences
-* Giving and gracefully accepting constructive feedback
-* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
-* Focusing on what is best not just for us as individuals, but for the overall community
-
-Examples of unacceptable behavior include:
-
-* The use of sexualized language or imagery, and sexual attention or
-  advances of any kind
-* Trolling, insulting or derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or email
-  address, without their explicit permission
-* Other conduct which could reasonably be considered inappropriate in a
-  professional setting
-
-## Enforcement Responsibilities
-
-Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
-
-Community leaders 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, and will communicate reasons for moderation decisions when appropriate.
-
-## Scope
-
-This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at searls@gmail.com. All complaints will be reviewed and investigated promptly and fairly.
-
-All community leaders are obligated to respect the privacy and security of the reporter of any incident.
-
-## Enforcement Guidelines
-
-Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
-
-### 1. Correction
-
-**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
-
-**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
-
-### 2. Warning
-
-**Community Impact**: A violation through a single incident or series of actions.
-
-**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
-
-### 3. Temporary Ban
-
-**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
-
-**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
-
-### 4. Permanent Ban
-
-**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
-
-**Consequence**: A permanent ban from any sort of public interaction within the community.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
-available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
-
-Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
-
-[homepage]: https://www.contributor-covenant.org
-
-For answers to common questions about this code of conduct, see the FAQ at
-https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.