fact_is_fact 0.3.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bbef6569a8515eff3ee4c4e6137b832367a4fb0b
-  data.tar.gz: b8f37c6ebec400b96fdc0788d3b5d2594f471fbf
+SHA256:
+  metadata.gz: e0669d6d8cc1793530b82447f4a2e1e897630cf30aa109fee1db3b851fcfb610
+  data.tar.gz: 700807423e7dc236871ab2e3eb70c72abe20cae79e7bb15d72e73b3180c01bb7
 SHA512:
-  metadata.gz: f72cf3278c24309a02f6dd04f2e31cc9c72a9b04fac0f22a2c496237b4f296d438ba4d58fd70cd346017e2d6a16365841f6e8fa3b43c6743577824c7eacf40bf
-  data.tar.gz: 32e9a44ab69470a1ebe23532757cf5771a0c550c5118379cced29277a8fc3f2e49d10c2a7840c3d530e9053b17ff77441a312685814d48d671fd369afe23bfbe
+  metadata.gz: a57fbde7abf78ee497cc35f570f6061e07cc288ec1103529c957e15ae2531b2cb5728809db70dbc3c9aed97753c330ce5b06973e86b64bbaf5d0c1a01c0e6af2
+  data.tar.gz: aec7f4ffd41e7febd7908b5d3c8a9d23fbca1660b770e4a8d90287a46652e197a9bbd5a1963e110096896bc5d7e6402cbab24b05a5c516d6a4dcd733489a2e14

data/CHANGELOG.md

@@ -0,0 +1,10 @@
+## Version 1.2.1
+Documentation for batch request
+
+## 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,35 +1,35 @@
 PATH
   remote: .
   specs:
-    fact_is_fact (0.2.0)
+    fact_is_fact (1.2.1)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    diff-lcs (1.3)
-    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.1)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    diff-lcs (1.4.4)
+    rake (13.0.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-19
 
 DEPENDENCIES
-  bundler (~> 1.17)
+  bundler (>= 2.2.17)
   fact_is_fact!
-  rake (~> 10.0)
-  rspec (~> 3.8.0)
+  rake (= 13.0.3)
+  rspec (= 3.10.0)
 
 BUNDLED WITH
-   1.17.2
+   2.2.19

data/README.md

@@ -1,9 +1,9 @@
 # FactIsFact
 
-This gem returns a fact about any number provided. It is useful when you want 
+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.
 
-P.S: Gem internally uses `numbersapi.com` to return the results.
+P.S: Gem internally uses http://numbersapi.com/ to return the results.
 
 ## Installation
 
@@ -22,12 +22,116 @@ Or install it yourself as:
     $ gem install fact_is_fact
 
 ## Usage
-Currently it only supports Random trivia about a number.
+* `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`
+
+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::Random.new(number: 42).trivia
-#=> "42 is the answer to the Ultimate Question of Life, the Universe, and Everything."
+FactIsFact.return(type: 'trivia', number: 'random', min: 10, max: 20)
+#=> "16 is the number of personality types in the Myers-Briggs classification system."
 ```
 
+### BATCH REQUESTS
+To get facts about multiple numbers in one request, specify ranges for number.
+
+A number range (inclusive) is specified as min..max. Separate multiple ranges and individual numbers with , (a comma).
+
+The response format will always be a JSON map from numbers to facts, of at most 100 numbers. The query parameter json may still be used to specify whether individual facts will be returned as string literals or JSON objects.
+
+```ruby
+FactIsFact.return(type: 'math', number: '1..3', json: '')
+=> "{\n \"1\": \"1 is the most common leading digit in many sets of data, a consequence of Benford's law.\",\n \"2\": \"2 is a primorial, as well as its own factorial.\",\n \"3\": \"3 is the fourth open meandric number.\"\n}"
+
+FactIsFact.return(type: 'math', number: '1..3,10,13,15', json: '')
+=> "{\n \"1\": \"1 is also the first and second numbers in the Fibonacci sequence and is the first number in many other mathematical sequences.\",\n \"2\": \"2 is the number of n-Queens Problem solutions for n = 4.\",\n \"3\": \"3 is the first unique prime due to the properties of its reciprocal.\",\n \"10\": \"10 is the aliquot sum of only one number the discrete semiprime 14.\",\n \"13\": \"13 is the number of Archimedian solids.\",\n \"15\": \"15 is a triangular number, a hexagonal number, a pentatope number and the 4th Bell number.\"\n}"
+
+FactIsFact.return(type: 'year', number: '1..3,10,13,15', json: '')
+=> "{\n \"1\": \"1 is the year that Emperor Ping of Han China begins his reign and Wang Mang is re-instated as regent by Grand Empress Dowager Wang.\",\n \"2\": \"2 is the year that Cedeides becomes Archon of Athens.\",\n \"3\": \"3 is the year that Augustus adopts his grandson, Gaius Caesar, with the expectation that he will succeed him.\",\n \"10\": \"10 is the year that Ovid completes Tristia (the \\\"Sorrows\\\", 5 books) and Epistulae ex Ponto (Letters from the Black Sea, 4 books) describing the sadness of banishment.\",\n \"13\": \"13 is the year that Strabo publishes his book on the shape of the Earth.\",\n \"15\": \"15 is the year that Germanicus captures Thusnelda, the wife of Arminius.\"\n}"
+```
+
+
+
+
 ## Development
 
 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.
@@ -36,7 +140,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,7 +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 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 3.8.0'
+  spec.add_development_dependency 'bundler', '>= 2.2.17'
+  spec.add_development_dependency 'rake', '13.0.3'
+  spec.add_development_dependency 'rspec', '3.10.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.2.1'.freeze

metadata

@@ -1,58 +1,58 @@
 --- !ruby/object:Gem::Specification
 name: fact_is_fact
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 1.2.1
 platform: ruby
 authors:
-- Aks
+- Abhinay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-06-14 00:00:00.000000000 Z
+date: 2021-07-01 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.2.17
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.17'
+        version: 2.2.17
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 13.0.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.8.0
+        version: 3.10.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - '='
       - !ruby/object:Gem::Version
-        version: 3.8.0
-description: library helps you display random facts
+        version: 3.10.0
+description: library helps you display random facts about a number or date or a year.
 email:
 - abhinay302@gmail.com
 executables: []
@@ -61,6 +61,7 @@ extra_rdoc_files: []
 files:
 - ".gitignore"
 - ".travis.yml"
+- CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - Gemfile
 - Gemfile.lock
@@ -71,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
@@ -80,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:
@@ -96,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.6
 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.3.0"
-end