giphyrb 0.1 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 31774a6f302e4b50bb9fd3554fedf0902bfd659e
-  data.tar.gz: 62f184a4939cddd5ece2076f8f6e6d86444a4d74
+  metadata.gz: d219e3e52055561188677535177d1526b5cd04eb
+  data.tar.gz: 6c14791d1ee93b2eeace31726f94473edbcaa3c7
 SHA512:
-  metadata.gz: 58afb5f6339f4bf295739935331f368829b7272af4af42a6a59f9d718776835adc920a6bd3a1e125a67d21ce077bb2e0c5f3cc5af8bb331877b589ff22d7d293
-  data.tar.gz: 9d82a50f883a566932a8bd074cf987744a358bf1bc5cbc54e348ee75e7ff3be29f4d45523163d98134d58e47447dd1da2454764886ec158c33fa21cd407fdc4e
+  metadata.gz: bad7c46279544a65b77076a43105ae91af419159ab1e3531f7e16581393f7bf710aa0bd74f8f8468a3e764b7c5113311aa921f919bac741cf23ce98b49cce8e7
+  data.tar.gz: 6fc5bc7a42372048ae7d7d488d8a771325b70d6107b57d43bb318b3410dbfd995903120a1b38c122f9392aa7a00b56e144b6378fd7a86aeaeeea071b7f478618

data/README.MD

@@ -1,4 +1,5 @@
 # GiphyRB
+[![Gem Version](https://badge.fury.io/rb/giphyrb.svg)](https://badge.fury.io/rb/giphyrb)
 ## Installation
 
 Add this line to your application's Gemfile:
@@ -29,34 +30,40 @@ giphy.trending(limit=5, offset=0, rating='g')
 
 #### Translate
 ````ruby
-Giphy.translate(string)
+giphy.translate(string)
 => GiphyRB::Responses::Translate
 ````
 
 #### Search
 ````ruby
-Giphy.search(query, limit=5, offset=0, rating='g', lang=nil)
+giphy.search(query, limit=5, offset=0, rating='g', lang=nil)
 => GiphyRB::Responses::Search
 ````
 
 #### Random
 ````ruby
-Giphy.random(tag=nil, rating='g')
+giphy.random(tag=nil, rating='g')
 => GiphyRB::Responses::Random
 ````
 
 #### GIF by ID
 ````ruby
-Giphy.from_id(id)
+giphy.from_id(id)
 => GiphyRB::Response
 ````
 
 #### GIFs by IDs
 ````ruby
-Giphy.from_ids(ids=[])
+giphy.from_ids(ids=[])
 => GiphyRB::Response
 ````
 
 ## License
 
-See [LICENSE](https://github.com/Whaxion/giphyrb/blob/master/LICENSE) for details.
+See [LICENSE](https://github.com/Whaxion/giphyrb/blob/master/LICENSE) for details.
+
+##TODO list
+
+- Add Sticker API
+- Document code
+- Improve user experience (new syntax)

data/giphyrb.gemspec

@@ -1,3 +1,5 @@
+require_relative 'lib/giphyrb'
+
 Gem::Specification.new do |s|
   s.summary     = 'Giphy API wrapper'
   s.description = 'A simple Giphy API Wrapper'
@@ -10,5 +12,5 @@ Gem::Specification.new do |s|
   s.license     = 'MIT'
 
   s.name        = 'giphyrb'
-  s.version     = '0.1'
+  s.version     = GiphyRB::Giphy::VERSION
 end

data/lib/giphyrb.rb

@@ -11,11 +11,22 @@ module GiphyRB
 
     ENDPOINT = 'http://api.giphy.com'
     API_VERSION = 'v1'
+    VERSION = '0.1.1'
 
+    # Initialize the client
     def initialize(api_key:true)
       @api_key = api_key
     end
 
+    # Search all GIPHY GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases.
+    # == Arguments
+    # +query+:: Search query term or phrase
+    # +limit+:: The maximum number of records to return (default=5)
+    # +offset+:: An optional results offset. (default=0)
+    # +rating+:: Filters results by specified rating (default=g)
+    # +lang+:: Specify default language for regional content; use a 2-letter ISO 639-1 language code (default=nil)
+    # == Return
+    # Responses::Search
     def search(query, limit=5, offset=0, rating='g', lang=nil)
       params = {:q => query, :limit => limit.to_i, :offset => offset.to_i, :rating => rating}
       params[:lang] = lang unless lang == nil
@@ -23,30 +34,58 @@ module GiphyRB
       Responses::Search.new(result, query)
     end
 
+    # Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the GIPHY homepage.
+    # == Arguments
+    # +limit+:: The maximum number of records to return (default=5)
+    # +offset+:: An optional results offset. (default=0)
+    # +rating+:: Filters results by specified rating (default=g)
+    # == Return
+    # Responses::Trending
     def trending(limit=5, offset=0, rating='g')
       params = {:limit => limit.to_i, :offset => offset.to_i, :rating => rating}
       result = request'gifs/trending', params
       Responses::Trending.new(result)
     end
 
+    # The translate API draws on search, but uses the GIPHY special sauce to handle translating from one vocabulary to another. In this case, words and phrases to GIFs.
+    # == Arguments
+    # +string+:: Search term
+    # == Return
+    # Responses::Translate
     def translate(string)
       params = {:s => string}
       result = request'gifs/translate', params
-      Responses::Trending.new(result)
+      Responses::Translate.new(result)
     end
 
+    # Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.
+    # == Arguments
+    # +tag+:: Filters results by specified tag
+    # +rating+:: Filters results by specified rating (default=g)
+    # == Return
+    # Responses::Random
     def random(tag=nil, rating='g')
       params = {:tag => tag, :rating => rating}
       result = request'gifs/random', params
       Responses::Random.new(result, tag)
     end
 
+    # Returns a GIF given that GIF's unique ID.
+    # == Arguments
+    # +id+:: Filters results by specified GIF ID
+    # == Return
+    # Response
     def from_id(id)
       params = {}
       result = request'gifs/' + id.to_s, params
       Response.new(result)
     end
 
+    # A multiget version of the get GIF by ID endpoint
+    # == Arguments
+    # +ids+:: Filters results by specified GIF IDs (Array)
+    # == Return
+    # Response
     def from_ids(ids=[])
       ids = Array(ids)
       ids = ids.join ','

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: giphyrb
 version: !ruby/object:Gem::Version
-  version: '0.1'
+  version: 0.1.1
 platform: ruby
 authors:
 - Whaxion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-20 00:00:00.000000000 Z
+date: 2017-12-21 00:00:00.000000000 Z
 dependencies: []
 description: A simple Giphy API Wrapper
 email: