marvellous 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: fa12f807fe125845c3bfa3b93fc5318a46cdacbe
+  data.tar.gz: b7523a948345a7e7a5303280ed8959d909cab6b3
+SHA512:
+  metadata.gz: fe58a27d2294aece30dcaed4c139767d2068b63736f070cee27f6da79588cd7f39eb3a58200736e94bc5699c93a929d55dce118046e60139cce9cd2efa57af38
+  data.tar.gz: 8d99e9678960f8c9aa9c39770831f0a56fbfdc4ee05a0d41c70b2ce235122f68e222cf87cd8915716bae544ce923083fa301f9597aeee409c00574a4a297f87f

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in marvellous.gemspec
+gemspec

data/README.md

@@ -0,0 +1,2 @@
+# marvellous
+Marvel API Gem

data/Rakefile

@@ -0,0 +1,9 @@
+require "bundler/gem_tasks"
+
+task :console do
+  require 'pry'
+  require 'byebug'
+  require 'marvellous'
+  ARGV.clear
+  Pry.start
+end

data/lib/marvellous/client.rb

@@ -0,0 +1,79 @@
+module Marvellous
+  class Client
+    include HTTParty
+    base_uri 'http://gateway.marvel.com'
+
+    attr_accessor :public_key, :private_key
+
+    class InvalidRouteError < StandardError; end
+
+    DEF_PAGE_SIZE = 10
+    DEF_PAGE_NUM = 1
+
+    def initialize(options)
+      @public_key = options[:public_key]
+      @private_key = options[:private_key]
+      @prefix = '/v1/public'
+      @routes = Marvellous::ROUTES
+    end
+
+    private
+
+    def params(additional_params = {})
+      base_hash = { :apikey => public_key, :ts => ts, :hash => digest }
+      additional_params.merge(base_hash)
+    end
+
+    def digest
+      Digest::MD5.hexdigest("#{ts}#{private_key}#{public_key}")
+    end
+
+    def ts
+      begin
+        Time.now.to_i
+      end
+    end
+
+    def paginate(options)
+      return {} if options[:paginate] == false
+      page_num = options[:page_num] || DEF_PAGE_NUM
+      page_size = options[:page_size] || DEF_PAGE_SIZE
+      {offset: (page_num-1)*page_size, limit: page_size}
+    end
+
+    def build_uri(method, params={})
+      endpoint = "#{routes[method][:path]}"
+      if params.any?
+        params.each do |p_key, p_value|
+          endpoint.gsub!(":#{p_key.to_s}", p_value.to_s)
+        end
+      end
+      endpoint
+    end
+
+    def build_response_object(response)
+      Response.create(response)
+    end
+
+    def fetch_response(route, options = {})
+      self.class.get(@prefix+route, query: params(options), headers: { 'Accept-Encoding' => 'gzip' })
+    end
+
+    def routes
+      @routes
+    end
+
+    def method_missing(method, *args, &block)
+      if routes.keys.include?(method)
+        params = args[0] || {}
+        endpoint = build_uri(method, params)
+        page_hash = (routes[method][:collection] rescue false) ? paginate(params) : {}
+        response = fetch_response(endpoint, page_hash)
+        build_response_object(response)
+      else
+        raise InvalidRouteError, "#{method} is not defined in the routes."
+      end
+    end
+
+  end
+end

data/lib/marvellous/response.rb

@@ -0,0 +1,27 @@
+module Marvellous
+  class Response < Hash
+    include Hashie::Extensions::MergeInitializer
+    include Hashie::Extensions::KeyConversion
+    include Hashie::Extensions::MethodAccess
+    include Hashie::Extensions::IndifferentAccess
+
+    attr_reader :raw_response
+
+    def self.create(response)
+      case response.code
+      when 200
+        res = Response.new(response)
+        res['data']['results'] rescue res
+      else
+        InvalidResponse.new(response)
+      end
+    end
+
+    def initialize(base)
+      @base_response = base
+      super(base)
+    end
+  end
+
+  class InvalidResponse < Response; end
+end

data/lib/marvellous/routes.rb

@@ -0,0 +1,6 @@
+module Marvellous
+  ROUTES = {
+    'characters': {path: '/characters', collection: true},
+    'character': {path: '/characters/:id'}
+  }
+end

data/lib/marvellous/version.rb

@@ -0,0 +1,3 @@
+module Marvellous
+  VERSION = '0.1.0'
+end

data/lib/marvellous.rb

@@ -0,0 +1,11 @@
+require 'digest/md5'
+require 'httparty'
+require 'hashie'
+
+require "marvellous/version"
+require "marvellous/routes"
+require "marvellous/client"
+require "marvellous/response"
+
+module Marvellous
+end

data/marvellous.gemspec

@@ -0,0 +1,34 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marvellous/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "marvellous"
+  spec.version       = Marvellous::VERSION
+  spec.authors       = ["Nikhil Goyal"]
+  spec.email         = ["nikhilgoyal22@gmail.com"]
+  spec.description   = %q{Marvel Comics API Wrapper}
+  spec.summary       = %q{Marvel Comics API Wrapper}
+  spec.homepage      = ""
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 1.9.2")
+
+  spec.files = Dir["{lib,spec}/**/*", "[A-Z]*"] - ["Gemfile.lock"]
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_path = "lib"
+
+  if RUBY_VERSION == '1.9.2'
+    spec.add_dependency "httparty", "0.8.3"
+  else
+    spec.add_dependency "httparty", "~> 0.12.0"
+  end
+
+  spec.add_dependency "hashie", "~> 2.0"
+
+  spec.add_development_dependency "bundler", '~> 1.3'
+  spec.add_development_dependency "rake", '~>12.2'
+  spec.add_development_dependency "pry", '~> 0'
+  spec.add_development_dependency "byebug", '~> 9.1'
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: marvellous
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Nikhil Goyal
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+- !ruby/object:Gem::Dependency
+  name: hashie
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '12.2'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9.1'
+description: Marvel Comics API Wrapper
+email:
+- nikhilgoyal22@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/marvellous.rb
+- lib/marvellous/client.rb
+- lib/marvellous/response.rb
+- lib/marvellous/routes.rb
+- lib/marvellous/version.rb
+- marvellous.gemspec
+homepage: ''
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: Marvel Comics API Wrapper
+test_files: []