dad_jokes 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6458e7c7dea8b3f11a0781a7c001bcca45c25784
-  data.tar.gz: fbb508013a6343ab5f5ae3b4eb12b1bdec296b29
+  metadata.gz: 1a1ca86fccc05f9065e9b065c7669e0034661554
+  data.tar.gz: bb45121a2a6acf3ea48a7c673ea67e69881b9948
 SHA512:
-  metadata.gz: 4ed3ca953555fab8d47375cc1e60e425d1814ceb20037d1e9fa228dd53565b1c9627cd0b402876c96653211b024fd65788b6dc3ed5559afdf4161c256cfd7048
-  data.tar.gz: 5425d892c8398142888c50d991419ba910b9b9698efabe1229db83b3c72c4f6c10e881cda338d7c9eb833aec89d6d74ab33c30499d7b9f984df4232813efd2de
+  metadata.gz: baa66da84ea54254ea6ae94c65024e925f664e681b90ec5bc157a5faedba9bbebccdfcdd17a55ac09774b4ceec67b622e40710741dad5d2d41f877248aad6a65
+  data.tar.gz: 8e247ae1fdc2d7901917317c548cb524f11f869e22b31225de2cdc837c45785e2c5f93a408d03502c0bc96145dd798a3fab26eaa78bf2a3868da0fef512202b7

data/.gitignore

@@ -7,3 +7,4 @@
 /pkg/
 /spec/reports/
 /tmp/
+*.gem

data/README.md

@@ -5,56 +5,91 @@
 <br/>
 
 Welcome to <b>Dad Jokes</b>! <br/>
+_( Wait, [what's a Dad joke?](https://en.wikipedia.org/wiki/Dad_joke) )_ <br/>
+
 Generate random dad jokes using this gem.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+<b>1.</b> Add this line to your application's Gemfile:
 
 ``` ruby
 gem 'dad_jokes'
 ```
 
-And then execute:
+and then execute:
 
     $ bundle
 
-Or install it yourself as:
+<b>OR,</b>
+
+<b>2.</b> Install it yourself as:
 
     $ gem install dad_jokes
 
+and require in your script as : 
+```ruby
+require 'dad_jokes'
+```
+
 ## Usage
 
-#### #1 Generate a random Dad joke
+#### 1. Get a random Dad joke
 
 ``` ruby
+# Get a random joke
 DadJokes.random
 ```
 
-Sample Output #1 : ``"Dad, I'm hungry." "Hello, Hungry. I'm Dad."``
+Sample Output #1 : ``'"Dad, I'm hungry." "Hello, Hungry. I'm Dad."'``
 
-Sample Output #2 : ``Why didn’t the skeleton cross the road? Because he had no guts.``
+Sample Output #2 : ``'My dog used to chase people on a bike a lot. It got so bad I had to take his bike away.'``
 
-#### #2 Search for Dad jokes
+#### 2. Search for Dad jokes
 
 ``` ruby
-DadJokes.search(term:, limit:)
+# Get array of jokes by passing a search term ; and setting limit(optional)
+DadJokes.search(term: "cannibal", limit: 1)
 ```
 
-* _term:_ 
+Output : ``["A cannibal is someone who is fed up with people."]``
+
+* _term :_ 
    - (**required*) 
    - Search term goes here
-* _limit:_  
+* _limit :_  
    - (**optional*)
    - Set limit for the number of jokes (because, obviously you're tired of laughing!). 
-   - Default : <b>5 jokes</b>
+   - By default : <b>5 jokes</b>
+
+#### 3. Generate & save a random joke as image (in .png format)
+
+```ruby
+# Saves a random joke in png format
+DadJokes.random_image
+```
 
+_Sample Vector image :_ <br>
+![Random Joke](./img/joke_vX8MeFdUDlb.png)
+
+_Output to console :_ <br>
+``"Dad died because he couldn't remember his blood type. I will never forget his last words. Be positive. ( Saved as image in location: joke_vX8MeFdUDlb.png !)"``
+
+
+<b>NOTE:</b> If you're inside a Rails project, image will be saved to root of the directory. Otherwise, if you're running the method in a ruby script, the image will be saved in the relative directory.
+ 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/aswinsanakan/dad_jokes. 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](https://github.com/aswinsanakan/dad_jokes/issues) and pull requests are welcome on GitHub at https://github.com/aswinsanakan/dad_jokes. 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.
 
+Thanks to [icanhazdadjoke](https://icanhazdadjoke.com/) for the free API.
+You can submit new jokes [here](https://icanhazdadjoke.com/submit).
 
 ## License
 
 The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
 
+
+
+
+

data/dad_jokes.gemspec

@@ -6,11 +6,11 @@ require 'dad_jokes/version'
 Gem::Specification.new do |spec|
   spec.name          = "dad_jokes"
   spec.version       = DadJokes::VERSION
-  spec.authors       = ["aswinsanakan"]
+  spec.authors       = ["Aswin Sanakan"]
   spec.email         = ["aswinsanakan@gmail.com"]
 
   spec.summary       = %q{Gem to generate random popular Dad Jokes.}
-  spec.description   = %q{Gem to generate random popular Dad Jokes.}
+  spec.description   = %q{Gem to generate random popular Dad Jokes. Features include: Generating jokes, Search for jokes, Save a random joke as image (as .png), etc}
   spec.homepage      = "https://github.com/aswinsanakan/dad_jokes"
   spec.license       = "MIT"
 
@@ -34,8 +34,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "minitest", "~> 5.0"
 
-  spec.add_dependency "json"
-  spec.add_dependency "faraday"
-  spec.add_dependency "faraday_middleware"
-  spec.add_dependency "pry"
+  spec.add_dependency "json", '~> 1.8'
+  spec.add_dependency "faraday", '~> 0.13.1'
+  spec.add_dependency "faraday_middleware", '~> 0.12.2'
 end

data/lib/dad_jokes.rb

@@ -2,11 +2,11 @@ require "dad_jokes/version"
 require "faraday"
 require "faraday_middleware"
 require "json"
-require 'pry'
+require 'open-uri'
 
 module DadJokes
 
-  API_URL = "https://icanhazdadjoke.com/".freeze
+  API_URL = "https://icanhazdadjoke.com".freeze
   API_HEADERS = {"Accept": "application/json"}
   DEFAULT_LIMIT = 5
 
@@ -16,6 +16,18 @@ module DadJokes
     get_joke(joke_object)
   end
 
+  def self.random_image
+    uri = "/"
+    joke_object = parse_response(uri)
+    joke_id = get_id(joke_object)
+    image_uri = "/j/#{joke_id}.png"
+    url = File.join(API_URL, image_uri).to_s
+    download = open(url)
+    path = get_image_save_path(joke_id)
+    IO.copy_stream(download, path)
+    "#{get_joke(joke_object)} ( Saved as image in location: #{path} !)"
+  end
+
   def self.fetch(joke_id:)
     uri = "/j/#{joke_id}"
     joke_object = parse_response(uri)
@@ -41,9 +53,12 @@ module DadJokes
     joke_object['joke']
   end
 
+  def self.get_id(joke_object)
+    joke_object['id']
+  end
+
   def self.filter_jokes(jokes_hash)
-    # binding.pry
-    jokes_arr = jokes_hash['results']
+    jokes_arr = jokes_hash['results'] || []
     jokes = []
     jokes_arr.each do |joke|
       jokes << joke['joke']
@@ -55,8 +70,19 @@ module DadJokes
     Faraday.new(url: API_URL, headers: API_HEADERS)
   end
 
-  def self.parse_response(body)
-    
+  def self.get_image_save_path(joke_id)
+    if in_rails_app?
+      File.join(Rails.root,"public","dadjokes","joke_#{joke_id}.png")
+    else
+      "joke_#{joke_id}.png"
+    end 
+  end
+
+  def self.in_rails_app?
+    klass = Module.const_get("Rails")
+    return klass.is_a?(Module)
+  rescue NameError
+    return false
   end
 
 end

data/lib/dad_jokes/version.rb

@@ -1,3 +1,3 @@
 module DadJokes
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dad_jokes
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
-- aswinsanakan
+- Aswin Sanakan
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-26 00:00:00.000000000 Z
+date: 2017-11-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,59 +56,46 @@ dependencies:
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.8'
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.13.1
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   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: pry
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 0.12.2
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
-description: Gem to generate random popular Dad Jokes.
+        version: 0.12.2
+description: 'Gem to generate random popular Dad Jokes. Features include: Generating
+  jokes, Search for jokes, Save a random joke as image (as .png), etc'
 email:
 - aswinsanakan@gmail.com
 executables: []