fact_is_fact 1.0.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dc48d93a01e894b9d9bfb586b5d746b280d9442eba9fb8ca98aed3cf4929ba9b
-  data.tar.gz: a7cf16c34b44a82b7452e27f3904f29bff439da81c25e1c39602f3aaa549dcd1
+  metadata.gz: 7fcc04684ad58972db23d324bfa82a35d2f77f04b1293e691058832900fd28a9
+  data.tar.gz: 14d52d4b72e2286edfac1b2ca1f4769db168041ed1b61e25c8d6252ab7385b85
 SHA512:
-  metadata.gz: 48d51934ae5b2aa3c6e887b4c8f39665872875b2adbc98d8896d8b37ccd6579c52c427f5a70b425abd439845c360248383c025aa3cf15a137108aed7e27559c9
-  data.tar.gz: ace65547c7f70afab343ce5bbada2347b2ee176a2735b6e63146534dc096cf212ce857281220db78227d6d4ebe33c03c6c5955ec61ba24a934cdb0b19a86913c
+  metadata.gz: e8a419e7ee87fb12a3427eebe68aac249ae5506dd6d52679551ae06555e2382298b1f30caf0eabef9e3dec6a7f5966d524f67330e92ee46fa1b348faefaa64cb
+  data.tar.gz: a527e9434408979a75f7e41af308da05669d804a1242f3936ccb5b91792883c66b621538b7896272047fe3d25f876f9b36edba2a4cdb82de2a79877d1a0df4bf

data/CHANGELOG.md

@@ -1,4 +1,7 @@
+## Version 1.1.0
+Ability to pass optional params with the request
+
 ## Version 1.0.0
-Deprecating the old way 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.
+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,7 +1,7 @@
 PATH
   remote: .
   specs:
-    fact_is_fact (1.0.0)
+    fact_is_fact (1.1.1)
 
 GEM
   remote: https://rubygems.org/

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,10 +22,93 @@ 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."
 ```
 
 ## Development

data/lib/fact_is_fact.rb

@@ -5,10 +5,11 @@ class FactIsFact
   TYPE = %w[trivia math year date].freeze
 
   class << self
-    def return(type:, number:)
+    def return(type:, number:, **options)
       return 'not a valid type' unless TYPE.include?(type)
 
-      number_facts_uri = URI("#{BASE_URI}/#{number}/#{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

data/lib/version.rb

@@ -1 +1 @@
-VERSION = '1.0.0'.freeze
+VERSION = '1.1.1'.freeze

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fact_is_fact
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.1.1
 platform: ruby
 authors:
 - Abhinay
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-10-29 00:00:00.000000000 Z
+date: 2021-05-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler