giphyrb 0.1.1 → 0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d219e3e52055561188677535177d1526b5cd04eb
-  data.tar.gz: 6c14791d1ee93b2eeace31726f94473edbcaa3c7
+  metadata.gz: 3269d612a4d65ab52aee537e67361d5c6442ccc8
+  data.tar.gz: 4a2e1a9c3bec82d830a1840675de27842d9fe47b
 SHA512:
-  metadata.gz: bad7c46279544a65b77076a43105ae91af419159ab1e3531f7e16581393f7bf710aa0bd74f8f8468a3e764b7c5113311aa921f919bac741cf23ce98b49cce8e7
-  data.tar.gz: 6fc5bc7a42372048ae7d7d488d8a771325b70d6107b57d43bb318b3410dbfd995903120a1b38c122f9392aa7a00b56e144b6378fd7a86aeaeeea071b7f478618
+  metadata.gz: 7d29b2607aa8d52d8365e6c4a23a7bee4a8b8cf93a298bf630bf7581d2da4c72ef79f1e291e7a39c204340dbe6aecce13726e4e87c23bf90a4c58f29bcc97f1d
+  data.tar.gz: ad6fc01e3b4d2af3f21839a9df5b6ae860c10d8138dc63cc45dfeaae2e063f92cb9464997276b806bc4b0330315e8f2d2be20eac24afbf7025b0bc97b5238f28

data/.gitignore

@@ -0,0 +1 @@
+*.gem

data/README.MD

@@ -62,8 +62,7 @@ giphy.from_ids(ids=[])
 
 See [LICENSE](https://github.com/Whaxion/giphyrb/blob/master/LICENSE) for details.
 
-##TODO list
+## TODO list
 
-- Add Sticker API
-- Document code
-- Improve user experience (new syntax)
+- Add Stickers packs
+- Improve user experience (new syntax)

data/giphyrb.gemspec

@@ -2,7 +2,7 @@ require_relative 'lib/giphyrb'
 
 Gem::Specification.new do |s|
   s.summary     = 'Giphy API wrapper'
-  s.description = 'A simple Giphy API Wrapper'
+  s.description = GiphyRB::Giphy::DESCRIPTION
   s.authors     = ['Whaxion']
   s.email       = ['whaxion@gmail.com']
   s.homepage    = 'http://github.com/whaxion/giphyrb'

data/lib/giphyrb.rb

@@ -11,7 +11,8 @@ module GiphyRB
 
     ENDPOINT = 'http://api.giphy.com'
     API_VERSION = 'v1'
-    VERSION = '0.1.1'
+    VERSION = '0.2'
+    DESCRIPTION ='A simple Giphy API Wrapper supporting Stickers API (except Stickers pack)'
 
     # Initialize the client
     def initialize(api_key:true)
@@ -19,14 +20,12 @@ module GiphyRB
     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
+    # @param query [String] Search query term or phrase
+    # @param limit [Int] The maximum number of records to return (default=5)
+    # @param offset [Int] An optional results offset. (default=0)
+    # @param rating [String] Filters results by specified rating (default=g)
+    # @param lang [String] 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
@@ -35,12 +34,10 @@ module GiphyRB
     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
+    # @param limit [Int] The maximum number of records to return (default=5)
+    # @param offset [Int] An optional results offset. (default=0)
+    # @param rating [String] 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
@@ -48,10 +45,8 @@ module GiphyRB
     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
+    # @param string [String] Search term
+    # @return [Responses::Translate]
     def translate(string)
       params = {:s => string}
       result = request'gifs/translate', params
@@ -59,11 +54,9 @@ module GiphyRB
     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
+    # @param tag [String] Filters results by specified tag
+    # @param rating [String] 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
@@ -71,10 +64,8 @@ module GiphyRB
     end
 
     # Returns a GIF given that GIF's unique ID.
-    # == Arguments
-    # +id+:: Filters results by specified GIF ID
-    # == Return
-    # Response
+    # @param id [String] Filters results by specified GIF ID
+    # @return [Response]
     def from_id(id)
       params = {}
       result = request'gifs/' + id.to_s, params
@@ -82,10 +73,8 @@ module GiphyRB
     end
 
     # A multiget version of the get GIF by ID endpoint
-    # == Arguments
-    # +ids+:: Filters results by specified GIF IDs (Array)
-    # == Return
-    # Response
+    # @param ids [Array<String>] Filters results by specified GIF IDs
+    # @return [Response]
     def from_ids(ids=[])
       ids = Array(ids)
       ids = ids.join ','
@@ -94,6 +83,50 @@ module GiphyRB
       Response.new(result)
     end
 
+    # Replicates the functionality and requirements of the classic GIPHY search, but returns animated stickers rather than GIFs.
+    # @param query [String] Search query term or phrase
+    # @param limit [Int] The maximum number of records to return (default=5)
+    # @param offset [Int] An optional results offset. (default=0)
+    # @param rating [String] Filters results by specified rating (default=g)
+    # @param lang [String] Specify default language for regional content; use a 2-letter ISO 639-1 language code (default=nil)
+    # @return [Responses::Search]
+    def sticker_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
+      result = request'stickers/search', params
+      Responses::Search.new(result, query)
+    end
+
+    # Fetch Stickers currently trending online. Hand curated by the GIPHY editorial team.
+    # @param limit [Int] The maximum number of records to return (default=5)
+    # @param offset [Int] An optional results offset. (default=0)
+    # @param rating [String] Filters results by specified rating (default=g)
+    # @return [Responses::Trending]
+    def sticker_trending(limit=5, offset=0, rating='g')
+      params = {:limit => limit.to_i, :offset => offset.to_i, :rating => rating}
+      result = request'stickers/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.
+    # @param string [String] Search term
+    # @return [Responses::Translate]
+    def sticker_translate(string)
+      params = {:s => string}
+      result = request'stickers/translate', params
+      Responses::Translate.new(result)
+    end
+
+    # Returns a random Sticker, limited by tag. Excluding the tag parameter will return a random Sticker from the GIPHY catalog.
+    # @param tag [String] Filters results by specified tag
+    # @param rating [String] Filters results by specified rating (default=g)
+    # @return [Responses::Random]
+    def sticker_random(tag=nil, rating='g')
+      params = {:tag => tag, :rating => rating}
+      result = request'stickers/random', params
+      Responses::Random.new(result, tag)
+    end
+
     private
 
       def request(url, params)

metadata

@@ -1,22 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: giphyrb
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: '0.2'
 platform: ruby
 authors:
 - Whaxion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-21 00:00:00.000000000 Z
+date: 2017-12-22 00:00:00.000000000 Z
 dependencies: []
-description: A simple Giphy API Wrapper
+description: A simple Giphy API Wrapper supporting Stickers API (except Stickers pack)
 email:
 - whaxion@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".gitignore"
 - LICENSE
 - README.MD
 - giphyrb.gemspec