GiphyClient 1.0.0

data/spec/api/default_api_spec.rb

@@ -0,0 +1,260 @@
+=begin
+#giphy-api
+
+#Giphy's public api.
+
+OpenAPI spec version: 0.9.3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'spec_helper'
+require 'json'
+
+# Unit tests for GiphyClient::DefaultApi
+# Automatically generated by swagger-codegen (github.com/swagger-api/swagger-codegen)
+# Please update as you see appropriate
+describe 'DefaultApi' do
+  before do
+    # run before each test
+    @instance = GiphyClient::DefaultApi.new
+  end
+
+  after do
+    # run after each test
+  end
+
+  describe 'test an instance of DefaultApi' do
+    it 'should create an instact of DefaultApi' do
+      expect(@instance).to be_instance_of(GiphyClient::DefaultApi)
+    end
+  end
+
+  # unit tests for gifs_categories_category_get
+  # Category Tags Endpoint.
+  # Returns a list of tags for a given category. NOTE `limit` and `offset` must both be set; otherwise they're ignored.
+  # @param api_key Giphy API Key.
+  # @param category Filters results by category.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @option opts [Integer] :offset An optional results offset. Defaults to 0.
+  # @return [InlineResponse2004]
+  describe 'gifs_categories_category_get test' do
+    it "should work" do
+      resp = @instance.gifs_categories_category_get("dc6zaTOxFJmzC", "actions", {limit: 10, offset: 0})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.name).to_not be_empty
+      end
+    end
+  end
+
+  # unit tests for gifs_categories_category_tag_get
+  # Tagged Gifs Endpoint.
+  # Returns a list of gifs for a given tag (alias to `/gif/search`).
+  # @param api_key Giphy API Key.
+  # @param category Filters results by category.
+  # @param tag Filters results by tag.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @option opts [Integer] :offset An optional results offset. Defaults to 0.
+  # @return [InlineResponse2005]
+  describe 'gifs_categories_category_tag_get test' do
+    it "should work" do
+      resp = @instance.gifs_categories_category_tag_get("dc6zaTOxFJmzC", "actions", "breaking-up", {limit: 10, offset: 0})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.url).to_not be_empty
+      end
+    end
+  end
+
+  # unit tests for gifs_categories_get
+  # Categories Endpoint.
+  # Returns a list of categories.
+  # @param api_key Giphy API Key.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @return [InlineResponse2003]
+  describe 'gifs_categories_get test' do
+    it "should work" do
+      resp = @instance.gifs_categories_get("dc6zaTOxFJmzC", {limit: 10})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.name).to_not be_empty
+        expect(item.name_encoded).to_not be_empty
+      end
+    end
+  end
+
+  # unit tests for gifs_get
+  # Get GIFs by ID Endpoint
+  # A multiget version of the get GIF by ID endpoint.
+  # @param api_key Giphy API Key.
+  # @param ids Filters results by specified GIF IDs, separated by commas.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse200]
+  describe 'gifs_get test' do
+    it "should work" do
+      resp = @instance.gifs_get("dc6zaTOxFJmzC", "YfCuW2maPixri,BeL3iFbYzAsfu")
+      expect(resp.data.count).to eq(2)
+    end
+  end
+
+  # unit tests for gifs_gif_id_get
+  # Get GIF by ID Endpoint
+  # Returns a GIF given that GIF's unique ID
+  # @param api_key Giphy API Key.
+  # @param gif_id Filters results by specified GIF ID.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2001]
+  describe 'gifs_gif_id_get test' do
+    it "should work" do
+      resp = @instance.gifs_gif_id_get("dc6zaTOxFJmzC", "YfCuW2maPixri")
+      expect(resp.data.id).to eq("YfCuW2maPixri")
+    end
+  end
+
+  # unit tests for gifs_random_get
+  # Random Endpoint
+  # Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.
+  # @param api_key Giphy API Key.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :tag Filters results by specified tag.
+  # @option opts [String] :rating Filters results by specified rating.
+  # @option opts [String] :fmt Used to indicate the expected response format. Default is Json.
+  # @return [InlineResponse2002]
+  describe 'gifs_random_get test' do
+    it "should work" do
+      resp = @instance.gifs_random_get("dc6zaTOxFJmzC")
+      expect(resp.data.url).to_not be_empty
+    end
+  end
+
+  # unit tests for gifs_search_get
+  # Search Endpoint
+  # Search all Giphy GIFs for a word or phrase. Punctuation will be stripped and ignored. Use a plus or url encode for phrases. Example paul+rudd, ryan+gosling or american+psycho.
+  # @param api_key Giphy API Key.
+  # @param q Search query term or prhase.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @option opts [Integer] :offset An optional results offset. Defaults to 0.
+  # @option opts [String] :rating Filters results by specified rating.
+  # @option opts [String] :lang Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages <a href = \"../language-support\">here</a>.
+  # @option opts [String] :fmt Used to indicate the expected response format. Default is Json.
+  # @return [InlineResponse200]
+  describe 'gifs_search_get test' do
+    it "should work" do
+      resp = @instance.gifs_search_get("dc6zaTOxFJmzC", "cats", {limit: 10})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.url).to_not be_empty
+      end
+    end
+  end
+
+  # unit tests for gifs_translate_get
+  # Translate Endpoint
+  # 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 api_key Giphy API Key.
+  # @param s Search term.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2001]
+  describe 'gifs_translate_get test' do
+    it "should work" do
+      resp = @instance.gifs_translate_get("dc6zaTOxFJmzC", "cats")
+      expect(resp.data.url).to_not be_empty
+    end
+  end
+
+  # unit tests for gifs_trending_get
+  # Trending GIFs Endpoint
+  # Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the <a href = \"http://www.giphy.com\">GIPHY homepage</a>. Returns 25 results by default.
+  # @param api_key Giphy API Key.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @option opts [String] :rating Filters results by specified rating.
+  # @option opts [String] :fmt Used to indicate the expected response format. Default is Json.
+  # @return [InlineResponse200]
+  describe 'gifs_trending_get test' do
+    it "should work" do
+      resp = @instance.gifs_trending_get("dc6zaTOxFJmzC", {limit: 10})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.url).to_not be_empty
+      end
+    end
+  end
+
+  # unit tests for stickers_random_get
+  # Random Sticker Endpoint
+  # Returns a random GIF, limited by tag. Excluding the tag parameter will return a random GIF from the GIPHY catalog.
+  # @param api_key Giphy API Key.
+  # @param [Hash] opts the optional parameters
+  # @option opts [String] :tag Filters results by specified tag.
+  # @option opts [String] :rating Filters results by specified rating.
+  # @option opts [String] :fmt Used to indicate the expected response format. Default is Json.
+  # @return [InlineResponse2002]
+  describe 'stickers_random_get test' do
+    it "should work" do
+      resp = @instance.stickers_random_get("dc6zaTOxFJmzC")
+      expect(resp.data.url).to_not be_empty
+    end
+  end
+
+  # unit tests for stickers_search_get
+  # Sticker Search Endpoint
+  # Replicates the functionality and requirements of the classic GIPHY search, but returns animated stickers rather than GIFs.
+  # @param api_key Giphy API Key.
+  # @param q Search query term or prhase.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @option opts [Integer] :offset An optional results offset. Defaults to 0.
+  # @option opts [String] :rating Filters results by specified rating.
+  # @option opts [String] :lang Specify default country for regional content; use a 2-letter ISO 639-1 country code. See list of supported languages <a href = \"../language-support\">here</a>.
+  # @option opts [String] :fmt Used to indicate the expected response format. Default is Json.
+  # @return [InlineResponse200]
+  describe 'stickers_search_get test' do
+    it "should work" do
+      resp = @instance.stickers_search_get("dc6zaTOxFJmzC", "cats", {limit: 10})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.url).to_not be_empty
+      end
+    end
+  end
+
+  # unit tests for stickers_translate_get
+  # Sticker Translate Endpoint
+  # 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 api_key Giphy API Key.
+  # @param s Search term.
+  # @param [Hash] opts the optional parameters
+  # @return [InlineResponse2001]
+  describe 'stickers_translate_get test' do
+    it "should work" do
+      resp = @instance.gifs_translate_get("dc6zaTOxFJmzC", "cats")
+      expect(resp.data.url).to_not be_empty
+    end
+  end
+
+  # unit tests for stickers_trending_get
+  # Trending Stickers Endpoint
+  # Fetch GIFs currently trending online. Hand curated by the GIPHY editorial team. The data returned mirrors the GIFs showcased on the <a href = \"http://www.giphy.com\">GIPHY homepage</a>. Returns 25 results by default.
+  # @param api_key Giphy API Key.
+  # @param [Hash] opts the optional parameters
+  # @option opts [Integer] :limit The maximum number of records to return.
+  # @option opts [String] :rating Filters results by specified rating.
+  # @option opts [String] :fmt Used to indicate the expected response format. Default is Json.
+  # @return [InlineResponse200]
+  describe 'stickers_trending_get test' do
+    it "should work" do
+      resp = @instance.stickers_trending_get("dc6zaTOxFJmzC", {limit: 10})
+      expect(resp.data.count).to eq(10)
+      resp.data.each do |item|
+        expect(item.url).to_not be_empty
+      end
+    end
+  end
+end

data/spec/api_client_spec.rb

@@ -0,0 +1,225 @@
+=begin
+#giphy-api
+
+#Giphy's public api.
+
+OpenAPI spec version: 0.9.3
+
+Generated by: https://github.com/swagger-api/swagger-codegen.git
+
+=end
+
+require 'spec_helper'
+
+describe GiphyClient::ApiClient do
+  context 'initialization' do
+    context 'URL stuff' do
+      context 'host' do
+        it 'removes http from host' do
+          GiphyClient.configure { |c| c.host = 'http://example.com' }
+          expect(GiphyClient::Configuration.default.host).to eq('example.com')
+        end
+
+        it 'removes https from host' do
+          GiphyClient.configure { |c| c.host = 'https://wookiee.com' }
+          expect(GiphyClient::ApiClient.default.config.host).to eq('wookiee.com')
+        end
+
+        it 'removes trailing path from host' do
+          GiphyClient.configure { |c| c.host = 'hobo.com/v4' }
+          expect(GiphyClient::Configuration.default.host).to eq('hobo.com')
+        end
+      end
+
+      context 'base_path' do
+        it "prepends a slash to base_path" do
+          GiphyClient.configure { |c| c.base_path = 'v4/dog' }
+          expect(GiphyClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "doesn't prepend a slash if one is already there" do
+          GiphyClient.configure { |c| c.base_path = '/v4/dog' }
+          expect(GiphyClient::Configuration.default.base_path).to eq('/v4/dog')
+        end
+
+        it "ends up as a blank string if nil" do
+          GiphyClient.configure { |c| c.base_path = nil }
+          expect(GiphyClient::Configuration.default.base_path).to eq('')
+        end
+      end
+    end
+  end
+
+  describe "params_encoding in #build_request" do
+    let(:config) { GiphyClient::Configuration.new }
+    let(:api_client) { GiphyClient::ApiClient.new(config) }
+
+    it "defaults to nil" do
+      expect(GiphyClient::Configuration.default.params_encoding).to eq(nil)
+      expect(config.params_encoding).to eq(nil)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(nil)
+    end
+
+    it "can be customized" do
+      config.params_encoding = :multi
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:params_encoding]).to eq(:multi)
+    end
+  end
+
+  describe "timeout in #build_request" do
+    let(:config) { GiphyClient::Configuration.new }
+    let(:api_client) { GiphyClient::ApiClient.new(config) }
+
+    it "defaults to 0" do
+      expect(GiphyClient::Configuration.default.timeout).to eq(0)
+      expect(config.timeout).to eq(0)
+
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(0)
+    end
+
+    it "can be customized" do
+      config.timeout = 100
+      request = api_client.build_request(:get, '/test')
+      expect(request.options[:timeout]).to eq(100)
+    end
+  end
+
+  describe "#deserialize" do
+    it "handles Array<Integer>" do
+      api_client = GiphyClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[12, 34]')
+      data = api_client.deserialize(response, 'Array<Integer>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([12, 34])
+    end
+
+    it "handles Array<Array<Integer>>" do
+      api_client = GiphyClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '[[12, 34], [56]]')
+      data = api_client.deserialize(response, 'Array<Array<Integer>>')
+      expect(data).to be_instance_of(Array)
+      expect(data).to eq([[12, 34], [56]])
+    end
+
+    it "handles Hash<String, String>" do
+      api_client = GiphyClient::ApiClient.new
+      headers = {'Content-Type' => 'application/json'}
+      response = double('response', headers: headers, body: '{"message": "Hello"}')
+      data = api_client.deserialize(response, 'Hash<String, String>')
+      expect(data).to be_instance_of(Hash)
+      expect(data).to eq({:message => 'Hello'})
+    end
+  end
+
+  describe "#object_to_hash" do
+    it "ignores nils and includes empty arrays" do
+      # uncomment below to test object_to_hash for model
+      #api_client = GiphyClient::ApiClient.new
+      #_model = GiphyClient::ModelName.new
+      # update the model attribute below
+      #_model.id = 1 
+      # update the expected value (hash) below
+      #expected = {id: 1, name: '', tags: []}
+      #expect(api_client.object_to_hash(_model)).to eq(expected)
+    end
+  end
+
+  describe "#build_collection_param" do
+    let(:param) { ['aa', 'bb', 'cc'] }
+    let(:api_client) { GiphyClient::ApiClient.new }
+
+    it "works for csv" do
+      expect(api_client.build_collection_param(param, :csv)).to eq('aa,bb,cc')
+    end
+
+    it "works for ssv" do
+      expect(api_client.build_collection_param(param, :ssv)).to eq('aa bb cc')
+    end
+
+    it "works for tsv" do
+      expect(api_client.build_collection_param(param, :tsv)).to eq("aa\tbb\tcc")
+    end
+
+    it "works for pipes" do
+      expect(api_client.build_collection_param(param, :pipes)).to eq('aa|bb|cc')
+    end
+
+    it "works for multi" do
+      expect(api_client.build_collection_param(param, :multi)).to eq(['aa', 'bb', 'cc'])
+    end
+
+    it "fails for invalid collection format" do
+      expect(proc { api_client.build_collection_param(param, :INVALID) }).to raise_error(RuntimeError, 'unknown collection format: :INVALID')
+    end
+  end
+
+  describe "#json_mime?" do
+    let(:api_client) { GiphyClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.json_mime?(nil)).to eq false
+      expect(api_client.json_mime?('')).to eq false
+
+      expect(api_client.json_mime?('application/json')).to eq true
+      expect(api_client.json_mime?('application/json; charset=UTF8')).to eq true
+      expect(api_client.json_mime?('APPLICATION/JSON')).to eq true
+
+      expect(api_client.json_mime?('application/xml')).to eq false
+      expect(api_client.json_mime?('text/plain')).to eq false
+      expect(api_client.json_mime?('application/jsonp')).to eq false
+    end
+  end
+
+  describe "#select_header_accept" do
+    let(:api_client) { GiphyClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_accept(nil)).to be_nil
+      expect(api_client.select_header_accept([])).to be_nil
+
+      expect(api_client.select_header_accept(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_accept(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_accept(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+
+      expect(api_client.select_header_accept(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_accept(['text/html', 'application/xml'])).to eq('text/html,application/xml')
+    end
+  end
+
+  describe "#select_header_content_type" do
+    let(:api_client) { GiphyClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.select_header_content_type(nil)).to eq('application/json')
+      expect(api_client.select_header_content_type([])).to eq('application/json')
+
+      expect(api_client.select_header_content_type(['application/json'])).to eq('application/json')
+      expect(api_client.select_header_content_type(['application/xml', 'application/json; charset=UTF8'])).to eq('application/json; charset=UTF8')
+      expect(api_client.select_header_content_type(['APPLICATION/JSON', 'text/html'])).to eq('APPLICATION/JSON')
+      expect(api_client.select_header_content_type(['application/xml'])).to eq('application/xml')
+      expect(api_client.select_header_content_type(['text/plain', 'application/xml'])).to eq('text/plain')
+    end
+  end
+
+  describe "#sanitize_filename" do
+    let(:api_client) { GiphyClient::ApiClient.new }
+
+    it "works" do
+      expect(api_client.sanitize_filename('sun')).to eq('sun')
+      expect(api_client.sanitize_filename('sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('../sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('/var/tmp/sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('./sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('..\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('c:\var\tmp\sun.gif')).to eq('sun.gif')
+      expect(api_client.sanitize_filename('.\sun.gif')).to eq('sun.gif')
+    end
+  end
+end