fact_is_fact 0.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: fa3e4ac2b219d65a50ddca4c0f8f6d634af53d14
-  data.tar.gz: c1d090947956d48fe5d80843a30191a7a52d527b
+SHA256:
+  metadata.gz: 7fcc04684ad58972db23d324bfa82a35d2f77f04b1293e691058832900fd28a9
+  data.tar.gz: 14d52d4b72e2286edfac1b2ca1f4769db168041ed1b61e25c8d6252ab7385b85
 SHA512:
-  metadata.gz: 312b9d9adf9beaabd677335c488357a35a7f4d1530808a52463a99597fbcea516cc2938913f4e59b35d9569f468e19d5fafd05988be13cfad3737091125eb988
-  data.tar.gz: 07cc992a15097305fdc574089afc4053c15ba359e1dd094fa5bd5c11498515dfc42d58746d3ee9c1ab121ae88de5fe89aa7a1a5ca793926935eb48d6a534bfbd
+  metadata.gz: e8a419e7ee87fb12a3427eebe68aac249ae5506dd6d52679551ae06555e2382298b1f30caf0eabef9e3dec6a7f5966d524f67330e92ee46fa1b348faefaa64cb
+  data.tar.gz: a527e9434408979a75f7e41af308da05669d804a1242f3936ccb5b91792883c66b621538b7896272047fe3d25f876f9b36edba2a4cdb82de2a79877d1a0df4bf

data/CHANGELOG.md

@@ -0,0 +1,7 @@
+## Version 1.1.0
+Ability to pass optional params with the request
+
+## Version 1.0.0
+Deprecating the old way of calling the class method. With this version, you will be able to get trivia, math, year and date facts about the any number of a day.
+
+## Version 0.31.1

data/Gemfile.lock

@@ -1,37 +1,35 @@
 PATH
   remote: .
   specs:
-    fact_is_fact (0.1.0)
+    fact_is_fact (1.1.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    minitest (5.11.3)
-    rake (10.5.0)
+    diff-lcs (1.4.4)
+    rake (13.0.1)
     rspec (3.8.0)
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.1)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec-expectations (3.8.6)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+    rspec-mocks (3.8.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+    rspec-support (3.8.3)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (= 2.1.4)
   fact_is_fact!
-  minitest (~> 5.0)
-  rake (~> 10.0)
+  rake (~> 13.0)
   rspec (~> 3.8.0)
 
 BUNDLED WITH
-   1.17.2
+   2.1.4

data/README.md

@@ -1,8 +1,9 @@
 # FactIsFact
 
-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/fact_is_fact`. To experiment with that code, run `bin/console` for an interactive prompt.
+This gem returns a fact about any number provided. It is useful when you want
+some random trivia or facts to be displayed about a number, on your website.
 
-TODO: Delete this and the text above, and describe your gem
+P.S: Gem internally uses http://numbersapi.com/ to return the results.
 
 ## Installation
 
@@ -21,8 +22,94 @@ Or install it yourself as:
     $ gem install fact_is_fact
 
 ## Usage
+* `type` is one of `trivia`, `math`, `date`, or `year`. Defaults to `trivia` if omitted.
+* `number` is
+    * an `integer`, or
+    * the keyword `random`, for which we will try to return a random available fact, or
+    * a `day` of year in the form `month/day` (eg. 2/29, 1/09, 04/1), if `type` is `date`
 
-TODO: Write usage instructions here
+basic examples
+```ruby
+# math fact
+FactIsFact.return(type: 'math', number: '1234')
+#=> "1234 is the smallest 4-digit number with increasing digits."
+
+# date fact
+FactIsFact.return(type: 'date', number: '2/29')
+#=> "February 29th is the day in 1892 that St. Petersburg, Florida is incorporated."
+
+# year fact
+FactIsFact.return(type: 'year', number: '1234')
+#=> "1234 is the year that the Manden region raises against the Kaniaga kingdom."
+
+# trivia
+FactIsFact.return(type: 'trivia', number: 'random')
+#=> "150000000 is the number of items held in the British Library."
+```
+
+## Optional parameters
+
+### Result in JSON format
+Include the query parameter `json` or set the HTTP header `Content-Type` to `application/json` to return the fact and associated meta-data as a JSON object
+
+```ruby
+FactIsFact.return(type: 'math', number: '123', json: '')
+#=> "{\n \"text\": \"123 is the 10^{th} Lucas number.\",\n \"number\": 123,\n \"found\": true,\n \"type\": \"math\"\n}"
+
+FactIsFact.return(type: 'trivia', number: 'random', json: true)
+#=> "{\n \"text\": \"88 is the number of keys on a piano (36 black and 52 white).\",\n \"number\": 88,\n \"found\": true,\n \"type\": \"trivia\"\n}"
+
+FactIsFact.return(type: 'math', number: '12', json: nil)
+#=> "{\n \"text\": \"12 is a superfactorial, being the product of the first three factorials.\",\n \"number\": 12,\n \"found\": true,\n \"type\": \"math\"\n}"
+```
+**Note**: you can pass any value to `json`, as long as the parameter is present, it does not matter what the value of the `json` parameter is.
+
+### FRAGMENT
+Return the fact as a sentence fragment that can be easily included as part of a larger sentence. This means that the first word is lowercase and ending punctuation is omitted. For trivia and math, a noun phrase is returned that can be used in a sentence like "We now have more users than [fact as fragment]!".
+
+```ruby
+FactIsFact.return(type: 'math', number: '13', fragment: '')
+#=> "the number of Archimedian solids"
+
+FactIsFact.return(type: 'math', number: '139', fragment: nil)
+#=> "the number of unlabeled topologies with 5 elements"
+
+FactIsFact.return(type: 'year', number: '1920', fragment: true)
+#=> "the United States Congress refuses to ratify the Treaty of Versailles"
+```
+**Note**: you can pass any value to `fragment`, as long as the parameter is present, it does not matter what the value of the `fragment` parameter is.
+
+### Not Found
+The `notfound` field tells us what to do if the number is not found. You can give us
+
+* `floor` to round down to the largest number that does have an associated fact, and return that fact.
+```ruby
+FactIsFact.return(type: 'math', number: '123123123', notfound: 'floor')
+#=> "12988816 is the number of domino tilings of an 8\xC3\x978 checkerboard."
+```
+
+* `ceil`, which is like `floor` but rounds up to the smallest number that has an associated fact.
+```ruby
+FactIsFact.return(type: 'math', number: '123123123', notfound: 'ceil')
+#=> "215000000 is the number of mathematical constants are collected on the Plouffe's Inverter as of 2010."
+```
+
+### Default message (if notfound)
+
+* `default` to return one of our pre-written missing messages, or a message you supply with the default query field. This is the default behaviour.
+
+```ruby
+FactIsFact.return(type: 'math', number: '123123123', default: 'no facts found')
+#=> "no facts found"
+```
+
+## MIN AND MAX
+Restrict the range of values returned to the inclusive range [min, max] when random is given as the number.
+
+```ruby
+FactIsFact.return(type: 'trivia', number: 'random', min: 10, max: 20)
+#=> "16 is the number of personality types in the Myers-Briggs classification system."
+```
 
 ## Development
 
@@ -32,7 +119,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/fact_is_fact. 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.
+Bug reports and pull requests are welcome on GitHub at https://github.com/abhinaykumar/fact_is_fact. 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
 

data/fact_is_fact.gemspec

@@ -1,27 +1,25 @@
-
-lib = File.expand_path("../lib", __FILE__)
-$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "fact_is_fact/version"
+require './lib/fact_is_fact'
+require './lib/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "fact_is_fact"
-  spec.version       = FactIsFact::VERSION
-  spec.authors       = ["Aks"]
-  spec.email         = ["abhinay302@gmail.com"]
+  spec.name          = 'fact_is_fact'
+  spec.version       = VERSION
+  spec.authors       = ['Abhinay']
+  spec.email         = ['abhinay302@gmail.com']
 
-  spec.summary       = %q{Stating the fact with ease}
-  spec.description   = %q{library helps you display random facts}
-  spec.homepage      = "https://github.com/abhinaykumar/fact_is_fact"
-  spec.license       = "MIT"
+  spec.summary       = 'This gem allows users to get a random trivia about a number or date or a year'
+  spec.description   = 'library helps you display random facts about a number or date or a year.'
+  spec.homepage      = 'https://github.com/abhinaykumar/fact_is_fact'
+  spec.license       = 'MIT'
 
   # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
   # to allow pushing to a single host or delete this section to allow pushing to any host.
   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/abhinaykumar/fact_is_fact"
-    spec.metadata["changelog_uri"] = "Put your gem's CHANGELOG.md URL here."
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = 'https://github.com/abhinaykumar/fact_is_fact'
+    spec.metadata['changelog_uri'] = 'https://github.com/abhinaykumar/fact_is_fact/blob/master/CHANGELOG.md'
   else
     raise "RubyGems 2.0 or newer is required to protect against " \
       "public gem pushes."
@@ -36,8 +34,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.add_development_dependency 'bundler', '~> 1.17'
-  spec.add_development_dependency 'minitest', '~> 5.0'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'bundler', '2.1.4'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.8.0'
 end

data/lib/fact_is_fact.rb

@@ -1,8 +1,18 @@
-require 'fact_is_fact/version'
+require 'net/http'
 
-module FactIsFact
-  require 'net/http'
-  require 'fact_is_fact/random'
+class FactIsFact
+  BASE_URI = 'http://numbersapi.com'.freeze
+  TYPE = %w[trivia math year date].freeze
+
+  class << self
+    def return(type:, number:, **options)
+      return 'not a valid type' unless TYPE.include?(type)
+
+      query_params = URI.encode_www_form(options)
+      number_facts_uri = URI("#{BASE_URI}/#{number}/#{type}?#{query_params}")
+      Net::HTTP.get(number_facts_uri)
+    end
+  end
 
   class Error < StandardError; end
 end

data/lib/version.rb

@@ -0,0 +1 @@
+VERSION = '1.1.1'.freeze

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: fact_is_fact
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.1.1
 platform: ruby
 authors:
-- Aks
+- Abhinay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.1.4
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.17'
-- !ruby/object:Gem::Dependency
-  name: minitest
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '5.0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: 2.1.4
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -66,7 +52,7 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.8.0
-description: library helps you display random facts
+description: library helps you display random facts about a number or date or a year.
 email:
 - abhinay302@gmail.com
 executables: []
@@ -75,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -85,8 +72,7 @@ files:
 - bin/setup
 - fact_is_fact.gemspec
 - lib/fact_is_fact.rb
-- lib/fact_is_fact/random.rb
-- lib/fact_is_fact/version.rb
+- lib/version.rb
 homepage: https://github.com/abhinaykumar/fact_is_fact
 licenses:
 - MIT
@@ -94,7 +80,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/abhinaykumar/fact_is_fact
   source_code_uri: https://github.com/abhinaykumar/fact_is_fact
-  changelog_uri: Put your gem's CHANGELOG.md URL here.
+  changelog_uri: https://github.com/abhinaykumar/fact_is_fact/blob/master/CHANGELOG.md
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -110,9 +96,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.2.2
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Stating the fact with ease
+summary: This gem allows users to get a random trivia about a number or date or a
+  year
 test_files: []

data/lib/fact_is_fact/random.rb

@@ -1,15 +0,0 @@
-module FactIsFact
-  class Random
-
-    def initialize(args)
-      @number = args[:number] || 'random'
-      @fact_type = args[:fact_type]
-      @base_uri = 'http://numbersapi.com'
-    end
-
-    def trivia
-      number_facts_uri = URI("#{@base_uri}/#{@number}/#{@fact_type}")
-      Net::HTTP.get(number_facts_uri)
-    end
-  end
-end

data/lib/fact_is_fact/version.rb

@@ -1,3 +0,0 @@
-module FactIsFact
-  VERSION = "0.1.0"
-end