giphyrb 0.2 → 0.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3269d612a4d65ab52aee537e67361d5c6442ccc8
-  data.tar.gz: 4a2e1a9c3bec82d830a1840675de27842d9fe47b
+  metadata.gz: 28476508077c9a3104e73b7950cff9bb157651a9
+  data.tar.gz: b461c649458865a3bc69f7c3aa0485ddc474854a
 SHA512:
-  metadata.gz: 7d29b2607aa8d52d8365e6c4a23a7bee4a8b8cf93a298bf630bf7581d2da4c72ef79f1e291e7a39c204340dbe6aecce13726e4e87c23bf90a4c58f29bcc97f1d
-  data.tar.gz: ad6fc01e3b4d2af3f21839a9df5b6ae860c10d8138dc63cc45dfeaae2e063f92cb9464997276b806bc4b0330315e8f2d2be20eac24afbf7025b0bc97b5238f28
+  metadata.gz: '09ccf6f52f57cefd611a4158d97101866b5bc1aa8349e1026607f68dea180d41fbbf022c4621ed98be2928b74e2bf5bc000df6cc3382857ac08e8a67be5c9630'
+  data.tar.gz: 21400e4c36e5b4e3772e1272846147e7e76fa07673ebaed5097815496eaf3fc451b4219e48a857621ec49d0edfdde91f5a26cd7f8e393087774eba29edb94115

data/lib/giphyrb.rb

@@ -5,14 +5,15 @@ require_relative 'responses/search'
 require_relative 'responses/trending'
 require_relative 'responses/translate'
 require_relative 'responses/random'
+require_relative 'responses/sticker_pack'
 
 module GiphyRB
   class Giphy
 
     ENDPOINT = 'http://api.giphy.com'
     API_VERSION = 'v1'
-    VERSION = '0.2'
-    DESCRIPTION ='A simple Giphy API Wrapper supporting Stickers API (except Stickers pack)'
+    VERSION = '0.2.1'
+    DESCRIPTION ='A simple Giphy API Wrapper supporting Stickers API and Stickers packs (untested)'
 
     # Initialize the client
     def initialize(api_key:true)
@@ -22,7 +23,7 @@ module GiphyRB
     # Search all GIPHY GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases.
     # @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 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]
@@ -35,7 +36,7 @@ module GiphyRB
 
     # Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the GIPHY homepage.
     # @param limit [Int] The maximum number of records to return (default=5)
-    # @param offset [Int] An optional results offset. (default=0)
+    # @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')
@@ -86,7 +87,7 @@ module GiphyRB
     # 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 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]
@@ -99,7 +100,7 @@ module GiphyRB
 
     # 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 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')
@@ -127,6 +128,45 @@ module GiphyRB
       Responses::Random.new(result, tag)
     end
 
+    # Returns the metadata for any Sticker pack.
+    # @return [Responses::ChildPack]
+    def list_sticker_pack()
+      params = {}
+      result = request'stickers/packs/', params
+      Responses::ChildPack.new(result)
+    end
+
+    # Returns the metadata for any Sticker pack.
+    # @param id [String] Filters results by specified Sticker Pack ID
+    # @param limit [Int] The maximum number of records to return (default=5)
+    # @param offset [Int] An optional results offset (default=0)
+    # @return [Responses::StickerPack]
+    def individual_sticker_pack_from_id(id, limit=5, offset=0)
+      params = {:limit => limit.to_i, :offset => offset.to_i}
+      result = request'stickers/packs/' + id.to_s, params
+      Responses::StickerPack.new(result)
+    end
+
+    # Returns the stickers within an individual sticker pack.
+    # @param id [String] Filters results by specified Sticker Pack ID
+    # @param limit [Int] The maximum number of records to return (default=5)
+    # @param offset [Int] An optional results offset (default=0)
+    # @return [Response]
+    def sticker_pack_from_id(id, limit=5, offset=0)
+      params = {:limit => limit.to_i, :offset => offset.to_i}
+      result = request'stickers/packs/' + id.to_s + '/stickers', params
+      Response.new(result)
+    end
+
+    # A Sticker pack is a recursive data structure and so packs may contain other packs. For example, the 'Reactions' pack would have an 'OMG' child pack. This endpoint lists all children packs of a given Sticker pack.
+    # @param id [String] Filters results by specified Sticker Pack ID
+    # @return [Response]
+    def children_pack_from_id(id)
+      params = {}
+      result = request'stickers/packs/' + id.to_s + '/children', params
+      Responses::ChildPack.new(result)
+    end
+
     private
 
       def request(url, params)

data/lib/parts/ancestor.rb

@@ -0,0 +1,24 @@
+module GiphyRB
+
+  module Parts
+
+    class Ancestor
+
+      attr_reader :id, :slug, :display_name, :short_display_name, :featured_gif_id, :parent, :has_children, :banner_image
+
+      def initialize(arr)
+        @arr = arr
+        @id = arr['id'] unless arr['id'] == nil
+        @slug = arr['slug'] unless arr['slug'] == nil
+        @display_name = arr['display_name'] unless arr['display_name'] == nil
+        @short_display_name = arr['short_display_name'] unless arr['short_display_name'] == nil
+        @featured_gif_id = arr['featured_gif_id'] unless arr['featured_gif_id'] == nil
+        @parent = arr['parent'] unless arr['parent'] == nil
+        @has_children = arr['has_children'] unless arr['has_children'] == nil
+        @banner_image = arr['banner_image'] unless arr['banner_image'] == nil
+      end
+
+    end
+
+  end
+end

data/lib/parts/child_pack.rb

@@ -0,0 +1,31 @@
+require_relative 'gif'
+require_relative 'user'
+
+module GiphyRB
+
+  module Parts
+
+    class ChildPack
+
+      attr_reader :type, :id, :parent, :type, :content_type, :slug, :display_name, :short_display_name, :description, :banner_image, :has_children, :user, :featured_gif
+
+      def initialize(arr)
+        @arr = arr
+        @id = arr['id'] unless arr['id'] == nil
+        @parent = arr['parent'] unless arr['parent'] == nil
+        @type = arr['type'] unless arr['type'] == nil
+        @content_type = arr['content_type'] unless arr['content_type'] == nil
+        @slug = arr['slug'] unless arr['slug'] == nil
+        @display_name = arr['display_name'] unless arr['display_name'] == nil
+        @short_display_name = arr['short_display_name'] unless arr['short_display_name'] == nil
+        @description = arr['description'] unless arr['description'] == nil
+        @banner_image = arr['banner_image'] unless arr['banner_image'] == nil
+        @has_children = arr['has_children'] unless arr['has_children'] == nil
+        @user = User.new(arr['user']) unless arr['user'] == nil
+        @featured_gif = Gif.new(arr['featured_gif']) unless arr['featured_gif'] == nil
+      end
+
+    end
+
+  end
+end

data/lib/parts/gif.rb

@@ -32,6 +32,8 @@ module GiphyRB
         @images = parse_images(arr['images']) unless arr['images'] == nil
       end
 
+      private
+
       def parse_images(arr)
         images = {}
         arr.each do |name, data|

data/lib/parts/sticker_pack.rb

@@ -0,0 +1,50 @@
+require_relative 'gif'
+require_relative 'user'
+require_relative 'tag'
+require_relative 'ancestor'
+
+module GiphyRB
+
+  module Parts
+
+    class StickerPack
+
+      attr_reader :type, :id, :type, :content_type, :slug, :display_name, :short_display_name, :description, :banner_image, :has_children, :user, :featured_gif
+
+      def initialize(arr)
+        @arr = arr
+        @id = arr['id'] unless arr['id'] == nil
+        @display_name = arr['display_name'] unless arr['display_name'] == nil
+        @slug = arr['slug'] unless arr['slug'] == nil
+        @content_type = arr['content_type'] unless arr['content_type'] == nil
+        @short_display_name = arr['short_display_name'] unless arr['short_display_name'] == nil
+        @description = arr['description'] unless arr['description'] == nil
+        @banner_image = arr['banner_image'] unless arr['banner_image'] == nil
+        @has_children = arr['has_children'] unless arr['has_children'] == nil
+        @user = User.new(arr['user']) unless arr['user'] == nil
+        @featured_gif = Gif.new(arr['featured_gif']) unless arr['featured_gif'] == nil
+        @tags = parse_tags(arr['tags']) unless arr['tags'] == nil
+      end
+
+      private
+
+      def parse_tags(arr)
+        tags = []
+        arr.each do |tag|
+          tags[] = Tag.new(tag)
+        end
+        tags
+      end
+
+      def parse_ancestors(arr)
+        ancestors = []
+        arr.each do |tag|
+          ancestors[] = Ancestor.new(tag)
+        end
+        ancestors
+      end
+
+    end
+
+  end
+end

data/lib/parts/tag.rb

@@ -0,0 +1,18 @@
+module GiphyRB
+
+  module Parts
+
+    class Tag
+
+      attr_reader :tag, :rank
+
+      def initialize(arr)
+        @arr = arr
+        @tag = arr['tag'] unless arr['tag'] == nil
+        @rank = arr['rank'] unless arr['rank'] == nil
+      end
+
+    end
+
+  end
+end

data/lib/responses/child_pack.rb

@@ -0,0 +1,36 @@
+require_relative '../parts/child_pack'
+require_relative '../parts/meta'
+require_relative '../parts/pagination'
+
+module GiphyRB
+
+  module Responses
+
+    class ChildPack
+
+      attr_reader :status, :gifs, :meta, :pagination
+
+      def initialize(arr)
+        @arr = arr
+        @status = 500
+        unless arr == nil
+          @meta = Parts::Meta.new(arr['meta']) unless arr['meta'] == nil
+          @pagination = Parts::Pagination.new(arr['pagination']) unless arr['pagination'] == nil
+          @status = @meta.status unless @meta == nil
+          generate arr['data'] unless arr['data'] == nil
+        end
+      end
+
+      def generate(stickers)
+        stickers = [].push(stickers) unless stickers == nil
+        @sticker_pack = []
+        stickers.each do |sticker|
+          @sticker_pack.push Parts::ChildPack.new(sticker)
+        end
+        @sticker_pack
+      end
+
+    end
+
+  end
+end

data/lib/responses/sticker_pack.rb

@@ -0,0 +1,36 @@
+require_relative '../parts/sticker_pack'
+require_relative '../parts/meta'
+require_relative '../parts/pagination'
+
+module GiphyRB
+
+  module Responses
+
+    class StickerPack
+
+      attr_reader :status, :gifs, :meta, :pagination
+
+      def initialize(arr)
+        @arr = arr
+        @status = 500
+        unless arr == nil
+          @meta = Parts::Meta.new(arr['meta']) unless arr['meta'] == nil
+          @pagination = Parts::Pagination.new(arr['pagination']) unless arr['pagination'] == nil
+          @status = @meta.status unless @meta == nil
+          generate arr['data'] unless arr['data'] == nil
+        end
+      end
+
+      def generate(stickers)
+        stickers = [].push(stickers) unless stickers == nil
+        @sticker_pack = []
+        stickers.each do |sticker|
+          @sticker_pack.push Parts::StickerPack.new(sticker)
+        end
+        @sticker_pack
+      end
+
+    end
+
+  end
+end

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: giphyrb
 version: !ruby/object:Gem::Version
-  version: '0.2'
+  version: 0.2.1
 platform: ruby
 authors:
 - Whaxion
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-12-22 00:00:00.000000000 Z
+date: 2018-01-11 00:00:00.000000000 Z
 dependencies: []
-description: A simple Giphy API Wrapper supporting Stickers API (except Stickers pack)
+description: A simple Giphy API Wrapper supporting Stickers API and Stickers packs
+  (untested)
 email:
 - whaxion@gmail.com
 executables: []
@@ -22,14 +23,20 @@ files:
 - README.MD
 - giphyrb.gemspec
 - lib/giphyrb.rb
+- lib/parts/ancestor.rb
+- lib/parts/child_pack.rb
 - lib/parts/gif.rb
 - lib/parts/image.rb
 - lib/parts/meta.rb
 - lib/parts/pagination.rb
+- lib/parts/sticker_pack.rb
+- lib/parts/tag.rb
 - lib/parts/user.rb
 - lib/response.rb
+- lib/responses/child_pack.rb
 - lib/responses/random.rb
 - lib/responses/search.rb
+- lib/responses/sticker_pack.rb
 - lib/responses/translate.rb
 - lib/responses/trending.rb
 homepage: http://github.com/whaxion/giphyrb