loadgif 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fc0b3850ce68bb81d186d8cda4ef23294871bf01760e858e5184500b45c629f4
-  data.tar.gz: 000a00611ebd43caa5c28b929b495db0b251d14dae31e23ed62af18f73617a7a
+  metadata.gz: 8d2c7c57d1b7f66787413b204547df95830b5c9838e4e81e913a833e37253599
+  data.tar.gz: caeb1d531a07d3b30e28827d2a720686ebc92803929d44f6cc51f2e9efc06cd9
 SHA512:
-  metadata.gz: 924ec23fbfee65839c8f34c33a9742462c29b0a483c97e2dd6c04a7df7dc6a9b09467adb2e1fa4823291e2cd91795bbd9cf30461ac5c80875be56c90ecda4194
-  data.tar.gz: d5920004834fe4d33c805c88c7cf54bd8f355d6d489f4826a1af09a2b2d5e415e562f216b956928bf1a285379e6c70a1d2a448beac5b95cb1070bc2f1146e0d3
+  metadata.gz: 2e015c1d12d40f638d1ded7072c060cedd17650d90c95cad42a43ad4423066730008b0e4f5312890a28c910788a8be8e7fdc2cd26d59d1133cd45671e343ce9e
+  data.tar.gz: 97abc8fcd6e07b051370a0c5987838eb99eeb805139350110a03eb244f24dd9246f31f36b4f0756b9b33ae79e5ca0476678a7d395907e6957543b90856570157

data/README.md

@@ -1,8 +1,9 @@
 # Loadgif
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/loadgif`. To experiment with that code, run `bin/console` for an interactive prompt.
+GIFs make fun! Use [Giphy API](http://api.giphy.com) from your Ruby programs and
+command line. Check out [Giphy Labs](http://labs.giphy.com/) for inspiration.
 
-TODO: Delete this and the text above, and describe your gem
+![](https://media.giphy.com/media/13p77tfexyLtx6/200.gif)
 
 ## Installation
 
@@ -22,7 +23,74 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Set the API `version` and `api_key`:
+
+```ruby
+Loadgif::Configuration.configure do |config|
+  config.version = THE_API_VERSION
+  config.api_key = YOUR_API_KEY
+end
+```
+
+**Important:** Giphy API is currently in public beta. Unless `version` and `api_key` are set
+to specific values the default values for the beta period will be used. Check
+[Giphy's API](http://labs.giphy.com/) for updates.
+
+That's it, you're ready to have fun!
+
+#### Trending
+````ruby
+Loadgif.trending(limit: 5)
+````
+
+#### Translate
+````ruby
+Loadgif.translate('geek')
+````
+
+#### Search
+````ruby
+Loadgif.search('funny cat', {limit: 50, offset: 25})
+````
+
+#### Favorites
+Write
+````ruby
+Loadgif.favorite('12HoHdqnDxz5NS')
+````
+Read
+````ruby
+Loadgif.favorites('absurdnoise', {limit: 50, offset: 25})
+````
+
+#### Screensaver
+````ruby
+Loadgif.screensaver('surprise')
+````
+
+#### Random
+````ruby
+Loadgif.random
+````
+
+For getting random gifs with a specific tag:
+
+````ruby
+Loadgif.random('american psycho')
+````
+
+#### GIFs by ID
+````ruby
+Loadgif.gif_by_id('13p77tfexyLtx6', 'l2Sqb0owUC5s5tz5m', 'xT9DPoKxz6nrODpwVa')
+````
+
+### Command Line Tool
+
+There is a small command line tool that let's you search for GIFs from the
+command line and opens it on your browser. Just for fun.
+
+    $ loadgif 'dance'
+
 
 ## Development
 
@@ -41,3 +109,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 ## Code of Conduct
 
 Everyone interacting in the Loadgif project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/loadgif/blob/master/CODE_OF_CONDUCT.md).
+

data/lib/loadgif.rb

@@ -1,9 +1,11 @@
 require "loadgif/version"
+require "uri"
+
+current_path = File.expand_path("../", __FILE__)
+Dir["#{current_path}/**/*.rb"].each { |file| require file }
 
 module Loadgif
   class Error < StandardError; end
   # Your code goes here...
-  def self.hi
-    puts "Hello world!"
-  end
+  extend Loadgif::Search
 end

data/lib/loadgif/cli.rb

@@ -0,0 +1,34 @@
+require 'launchy'
+
+module Loadgif
+  class CLI
+    def self.run(keyword)
+      new(keyword).search
+    end
+
+    def initialize(keyword)
+      @keyword = keyword
+    end
+
+    def search
+      system "echo 'Showing the GIF on your browser'"
+      Launchy.open(url)
+    end
+
+    private
+
+    attr_reader :keyword
+
+    def url
+      @url ||= URI("http://giphy.com/embed/#{result.id}")
+    end
+
+    def result
+      Loadgif.screensaver(keyword)
+    rescue Loadgif::Errors::API
+      GifNotFound.new('YyKPbc5OOTSQE')
+    end
+  end
+
+  GifNotFound = Struct.new(:id)
+end

data/lib/loadgif/client.rb

@@ -0,0 +1,61 @@
+module Loadgif
+  class Client
+    def trending(options={})
+      get('/trending', options)
+    end
+
+    def translate(word)
+      get('/translate', s: word)
+    end
+
+    def search(keyword, options={})
+      options_hash = {q: keyword}.merge(options)
+      get('/search', options_hash)
+    end
+
+    def favorite(id)
+      post("/#{id}/favorites")
+    end
+
+    def favorites(username='', options={})
+      options_hash = {username: username}.merge(options)
+      get('/favorites', options_hash)
+    end
+
+    def screensaver(tag)
+      get('/screensaver', tag: tag)
+    end
+
+    def random(tag='')
+      get('/random', { tag: tag })
+    end
+
+    def gif(id)
+      get("/#{id}")
+    end
+
+    def gifs(ids)
+      get('', ids: ids.join(','))
+    end
+
+    private
+
+    def get(path, options={})
+      api_response = request.get(path, options)
+      response(api_response)
+    end
+
+    def post(path, options={})
+      api_response = request.post(path, options)
+      response(api_response)
+    end
+
+    def request
+      Loadgif::Request
+    end
+
+    def response(api_response)
+      Loadgif::Response.build(api_response)
+    end
+  end
+end

data/lib/loadgif/configuration.rb

@@ -0,0 +1,23 @@
+module Loadgif
+  class Configuration
+    DEFAULT_VERSION  = 'v1'
+    DEFAULT_API_KEY  = 'jdS99NKYEMxgqe6s4amvZe1qgRV3TtVn'
+
+    class << self
+      attr_writer :version, :api_key
+
+      def configure(&block)
+        yield self
+        self
+      end
+
+      def version
+        @version ||= DEFAULT_VERSION
+      end
+
+      def api_key
+        @api_key ||= DEFAULT_API_KEY
+      end
+    end
+  end
+end

data/lib/loadgif/errors/api.rb

@@ -0,0 +1,5 @@
+module Giphy
+  module Errors
+    class API < StandardError ; end
+  end
+end

data/lib/loadgif/errors/argument_error.rb

@@ -0,0 +1,5 @@
+module Giphy
+  module Errors
+    class ArgumentError < StandardError ; end
+  end
+end

data/lib/loadgif/errors/unexpected.rb

@@ -0,0 +1,5 @@
+module Giphy
+  module Errors
+    class Unexpected < StandardError ; end
+  end
+end

data/lib/loadgif/favorite_gif.rb

@@ -0,0 +1,9 @@
+require 'Loadgif/special_gif'
+
+module Loadgif
+  class FavoriteGif < Loadgif::SpecialGif
+    def tag
+      hash.fetch('tag')
+    end
+  end
+end

data/lib/loadgif/gif.rb

@@ -0,0 +1,87 @@
+module Loadgif
+  class Gif
+    def self.build_batch_from(array_or_hash)
+      if array_or_hash.is_a?(Array)
+        array_or_hash.map { |gif| new(gif) }
+      else
+        new(array_or_hash)
+      end
+    end
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def id
+      hash.fetch('id')
+    end
+
+    def url
+      URI(hash.fetch('url', ''))
+    end
+
+    def bitly_gif_url
+      URI(hash.fetch('bitly_gif_url', ''))
+    end
+
+    def bitly_fullscreen_url
+      URI(hash.fetch('bitly_fullscreen_url', ''))
+    end
+
+    def bitly_tiled_url
+      URI(hash.fetch('bitly_tiled_url', ''))
+    end
+
+    def embed_url
+      URI(hash.fetch('embed_url', ''))
+    end
+
+    def fixed_height_image
+      @fixed_height_image ||= image(images['fixed_height'])
+    end
+
+    def fixed_height_still_image
+      @fixed_height_still_image ||= image(images['fixed_height_still'])
+    end
+
+    def fixed_height_downsampled_image
+      @fixed_height_downsampled_image ||= image(images['fixed_height_downsampled'])
+    end
+
+    def fixed_width_image
+      @fixed_width_image ||= image(images['fixed_width'])
+    end
+
+    def fixed_width_still_image
+      @fixed_width_still_image ||= image(images['fixed_width_still'])
+    end
+
+    def fixed_width_downsampled_image
+      @fixed_width_downsampled_image ||= image(images['fixed_width_downsampled'])
+    end
+
+    def original_image
+      @original_image ||= image(images['original'])
+    end
+
+    def image_original_url
+      URI(hash.fetch('image_original_url', ''))
+    end
+
+    private
+
+    attr_reader :hash
+
+    def images
+      @images ||= hash.fetch('images', {})
+    end
+
+    def image(image_hash)
+      image_hash ? Loadgif::Image.new(image_hash) : null_image
+    end
+
+    def null_image
+      NullImage.new
+    end
+  end
+end

data/lib/loadgif/gif_by_id.rb

@@ -0,0 +1,34 @@
+module Loadgif
+  class GifByID
+    def get(ids)
+      case ids.size
+      when 0
+        raise Loadgif::Errors::ArgumentError.new('wrong number of arguments (0 for 1...Infinite)')
+      when 1
+        one_gif(ids.first)
+      else
+        several_gifs(ids)
+      end
+    end
+
+    private
+
+    def one_gif(id)
+      result = client.gif(id)
+      gif.new(result)
+    end
+
+    def several_gifs(ids)
+      result = client.gifs(ids)
+      gif.build_batch_from(result)
+    end
+
+    def client
+      Loadgif::Client.new
+    end
+
+    def gif
+      Loadgif::Gif
+    end
+  end
+end

data/lib/loadgif/image.rb

@@ -0,0 +1,47 @@
+module Loadgif
+  class Image
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def url
+      URI(hash.fetch('url'))
+    end
+
+    def width
+      hash.fetch('width').to_i
+    end
+
+    def height
+      hash.fetch('height').to_i
+    end
+
+    def size
+      hash.fetch('size', 0).to_i
+    end
+
+    def frames
+      hash.fetch('frames', 0).to_i
+    end
+
+    def mp4
+      URI(hash.fetch('mp4'))
+    end
+
+    def mp4_size
+      hash.fetch('mp4_size', 0).to_i
+    end
+
+    def webp
+      URI(hash.fetch('webp'))
+    end
+
+    def webp_size
+      hash.fetch('webp_size', 0).to_i
+    end
+
+    private
+
+    attr_reader :hash
+  end
+end

data/lib/loadgif/null_image.rb

@@ -0,0 +1,23 @@
+module Loadgif
+  class NullImage
+    def url
+      URI('')
+    end
+
+    def width
+      0
+    end
+
+    def height
+      0
+    end
+
+    def size
+      0
+    end
+
+    def frames
+      0
+    end
+  end
+end

data/lib/loadgif/random_gif.rb

@@ -0,0 +1,59 @@
+module Loadgif
+  class RandomGif
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def id
+      hash.fetch('id')
+    end
+
+    def url
+      URI(hash.fetch('url'))
+    end
+
+    def image_original_url
+      URI(hash.fetch('image_original_url'))
+    end
+
+    def image_url
+      URI(hash.fetch('image_url'))
+    end
+
+    def image_mp4_url
+      URI(hash.fetch('image_mp4_url'))
+    end
+
+    def image_frames
+      hash.fetch('image_frames')
+    end
+
+    def image_width
+      hash.fetch('image_width')
+    end
+
+    def image_height
+      hash.fetch('image_height')
+    end
+
+    def rating
+      hash.fetch('rating')
+    end
+
+    def username
+      hash.fetch('username')
+    end
+
+    def caption
+      hash.fetch('caption')
+    end
+
+    def tags
+      hash.fetch('tags')
+    end
+
+    private
+
+    attr_reader :hash
+  end
+end

data/lib/loadgif/request.rb

@@ -0,0 +1,59 @@
+require 'faraday'
+require 'faraday_middleware'
+require 'faraday_middleware/parse_oj'
+
+module Loadgif
+  class Request
+    URL = 'http://api.giphy.com'
+
+    def self.get(path, options={})
+      new.get(path, options)
+    end
+
+    def self.post(path, options={})
+      new.post(path, options)
+    end
+
+    def get(path, options={})
+      connection.get(complete_path(path), complete_options(options))
+    end
+
+    def post(path, options={})
+      connection.post(complete_path(path), complete_options(options))
+    end
+
+    private
+
+    attr_reader :api_response
+
+    def connection
+      Faraday.new(url: URL) do |connection|
+        connection.use FaradayMiddleware::FollowRedirects
+        connection.use Faraday::Response::RaiseError
+        connection.request :url_encoded
+        connection.response :oj
+        connection.adapter Faraday.default_adapter
+      end
+    end
+
+    def version
+      configuration.version
+    end
+
+    def api_key
+      configuration.api_key
+    end
+
+    def configuration
+      Loadgif::Configuration
+    end
+
+    def complete_options(options)
+      {api_key: api_key}.merge(options)
+    end
+
+    def complete_path(path)
+      "/#{version}/gifs#{path}"
+    end
+  end
+end

data/lib/loadgif/response.rb

@@ -0,0 +1,28 @@
+module Loadgif
+  class Response
+    def self.build(response)
+      new(response).data
+    end
+
+    def initialize(response)
+      @response = response
+    end
+
+    def data
+      raise Loadgif::Errors::Unexpected unless response.body
+      response.body['data'] || raise(Loadgif::Errors::API.new(error))
+    end
+
+    private
+
+    attr_reader :response
+
+    def error
+      "#{meta['error_type']} #{meta['error_message']}"
+    end
+
+    def meta
+      @meta ||= response.body.fetch('meta')
+    end
+  end
+end

data/lib/loadgif/search.rb

@@ -0,0 +1,60 @@
+module Loadgif
+  module Search
+    def trending(options={})
+      result = client.trending(options)
+      gif.build_batch_from(result)
+    end
+
+    def translate(word)
+      result = client.translate(word)
+      gif.build_batch_from(result)
+    end
+
+    def search(keyword, options={})
+      result = client.search(keyword, options)
+      gif.build_batch_from(result)
+    end
+
+    def favorite(id)
+      result = client.favorite(id)
+      favorite_gif.new(result)
+    end
+
+    def favorites(username, options)
+      result = client.favorites(username, options)
+      favorite_gif.build_batch_from(result)
+    end
+
+    def screensaver(tag)
+      result = client.screensaver(tag)
+      gif.new(result)
+    end
+
+    def random(tag='')
+      result = client.random(tag)
+      random_gif.new(result)
+    end
+
+    def gif_by_id(*ids)
+      GifByID.new.get(ids)
+    end
+
+    private
+
+    def client
+      Loadgif::Client.new
+    end
+
+    def gif
+      Loadgif::Gif
+    end
+
+    def favorite_gif
+      Loadgif::FavoriteGif
+    end
+
+    def random_gif
+      Loadgif::RandomGif
+    end
+  end
+end

data/lib/loadgif/special_gif.rb

@@ -0,0 +1,25 @@
+require 'date'
+
+module Loadgif
+  class SpecialGif
+    def self.build_batch_from(array)
+      array.map { |special_gif| new(special_gif)}
+    end
+
+    def initialize(hash)
+      @hash = hash
+    end
+
+    def create_date
+      DateTime.parse(hash.fetch('create_date'))
+    end
+
+    def gif_id
+      hash.fetch('gif_id')
+    end
+
+    private
+
+    attr_reader :hash
+  end
+end

data/lib/loadgif/version.rb

@@ -1,3 +1,3 @@
 module Loadgif
-  VERSION = "0.1.0"
+  VERSION = "0.1.1"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: loadgif
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - cis-neelam
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-01 00:00:00.000000000 Z
+date: 2019-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -54,7 +54,24 @@ files:
 - bin/console
 - bin/setup
 - lib/loadgif.rb
+- lib/loadgif/cli.rb
+- lib/loadgif/client.rb
+- lib/loadgif/configuration.rb
+- lib/loadgif/errors/api.rb
+- lib/loadgif/errors/argument_error.rb
+- lib/loadgif/errors/unexpected.rb
+- lib/loadgif/favorite_gif.rb
+- lib/loadgif/gif.rb
+- lib/loadgif/gif_by_id.rb
+- lib/loadgif/image.rb
+- lib/loadgif/null_image.rb
+- lib/loadgif/random_gif.rb
+- lib/loadgif/request.rb
+- lib/loadgif/response.rb
+- lib/loadgif/search.rb
+- lib/loadgif/special_gif.rb
 - lib/loadgif/version.rb
+- loadgif-0.1.0.gem
 - loadgif.gemspec
 homepage: http://rubygems.org/gems/loadgif
 licenses: