marvel-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 46610bdc3daec86840705542f086110b4617c798
+  data.tar.gz: 4b79ec56c998d266e3c844233bc6975d0cc1ade5
+SHA512:
+  metadata.gz: f82f0761ba3bbb4416c68b8d6221cef2f633b829b0c5b87f6db730620f25619f4d5a187c6032e862ca05c84bf4a314355516f8a74d505164fd22e69fe8ec6af3
+  data.tar.gz: 1f4c466d1a3f518fc93ef2fc70af363379f26f53b7e808a31f34f4010ab079ff4e78755e948f3965f831f45e520cf77412e8e2453d169549fa33f99f8be9ad82

data/.env.example

@@ -0,0 +1,2 @@
+MARVEL_PUBLIC_KEY=
+MARVEL_PRIVATE_KEY=

data/.gitignore

@@ -0,0 +1,4 @@
+/.bundle/
+/Gemfile.lock
+/pkg/
+/.env

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,6 @@
+Documentation:
+  Enabled: false
+
+Metrics/BlockLength:
+    Exclude:
+      - 'spec/**/*.rb'

data/.travis.yml

@@ -0,0 +1,36 @@
+# Available ruby versions: http://rubies.travis-ci.org/
+
+language: ruby
+
+os:
+  - linux
+
+rvm:
+  - '2.1' # latest 2.1.x
+  - '2.2.6'
+  - '2.3.3'
+  - '2.4.0'
+  - 'ruby-head'
+
+script:
+  bundle exec rspec
+
+before_install:
+  # bundler installation needed for jruby-head
+  # https://github.com/travis-ci/travis-ci/issues/5861
+  - gem install bundler
+
+# Travis OS X support is pretty janky. These are some hacks to include tests
+# only on versions that actually work.
+# (last tested: 2016-11)
+matrix:
+  # exclude: {}
+  # include: {}
+
+  allow_failures:
+    - rvm: 'ruby-head'
+
+  # return results as soon as mandatory versions are done
+  fast_finish: true
+
+sudo: false

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Krzysztof Wawer
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,101 @@
+# Marvel::Api
+
+[![Build Status](https://travis-ci.org/comics-apps/marvel-api.svg?branch=master)](https://travis-ci.org/comics-apps/marvel-api)
+[![Code Climate](https://codeclimate.com/github/comics-apps/marvel-api.svg)](https://codeclimate.com/github/comics-apps/marvel-api)
+
+A simple Marvel API client for Ruby, inspired by the koala's gem style.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'marvel-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install marvel-api
+
+## Usage
+
+```ruby
+public_key = 'foo'
+private_key = 'bar'
+options = {}
+service = Marvel::Api.new(public_key, private_key, **options)
+```
+ 
+Gem provide universal method which allows you to create custom call to API:
+
+```ruby
+service.api_call(path, args, options)
+```
+
+* path - append to `http://comicvine.gamespot.com/api/`
+* args - query params
+* options - options for http service class
+
+Available methods:
+
+* `characters(args)`
+* `character(character_id, args)`
+* `character_comics(character_id, args)`
+* `character_events(character_id, args)`
+* `character_series(character_id, args)`
+* `character_stories(character_id, args)`
+* `comics(args)`
+* `comic(comic_id, args)`
+* `comic_characters(comic_id, args)`
+* `comic_events(comic_id, args)`
+* `comic_series(comic_id, args)`
+* `comic_stories(comic_id, args)`
+* `creators(args)`
+* `creator(creator_id, args)`
+* `creator_comics(creator_id, args)`
+* `creator_events(creator_id, args)`
+* `creator_series(creator_id, args)`
+* `creator_stories(creator_id, args)`
+* `events(args)`
+* `event(event_id, args)`
+* `event_characters(event_id, args)`
+* `event_comics(event_id, args)`
+* `event_creators(event_id, args)`
+* `event_series(event_id, args)`
+* `event_stories(event_id, args)`
+* `series(args)`
+* `serie(serie_id, args)`
+* `serie_characters(serie_id, args)`
+* `serie_comics(serie_id, args)`
+* `serie_creators(serie_id, args)`
+* `serie_events(serie_id, args)`
+* `serie_stories(serie_id, args)`
+* `stories(args)`
+* `story(story_id, args)`
+* `story_characters(story_id, args)`
+* `story_comics(story_id, args)`
+* `story_creators(story_id, args)`
+* `story_events(story_id, args)`
+* `story_series(story_id, args)`
+
+Check official API docs what arguments you can use: https://developer.marvel.com/docs
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/Krzysztof Wawer/marvel-api.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/lib/marvel/api.rb

@@ -0,0 +1,50 @@
+require 'marvel/api/api_methods'
+require 'marvel/api/http_service'
+require 'marvel/api/request'
+require 'marvel/api/response'
+require 'marvel/api/version'
+
+module Marvel
+  class Api
+    include ApiMethods
+
+    class << self
+      attr_accessor :http_service
+    end
+
+    self.http_service = HTTPService
+
+    DEFAULT_SERVER = 'http://gateway.marvel.com'.freeze
+
+    attr_reader :public_key, :private_key, :options
+
+    def initialize(public_key, private_key, options = {})
+      @public_key = public_key
+      @private_key = private_key
+      @options = options
+    end
+
+    def api_call(path, args, options = {})
+      request = Request.new(
+        path: path,
+        args: args.merge(apikey: public_key, ts: ts, hash: request_hash),
+        options: options
+      )
+      self.class.http_service.make_request(request)
+    end
+
+    def comics(args = {})
+      api_call('comics', args)
+    end
+
+    private
+
+    def ts
+      Time.now.utc.to_i
+    end
+
+    def request_hash
+      Digest::MD5.hexdigest("#{ts}#{private_key}#{public_key}")
+    end
+  end
+end

data/lib/marvel/api/api_methods.rb

@@ -0,0 +1,39 @@
+module Marvel
+  class Api
+    module ApiMethods
+      METHODS = {
+        characters: :character,
+        comics: :comic,
+        creators: :creator,
+        events: :event,
+        series: :serie,
+        stories: :story
+      }.freeze
+
+      SUBMETHODS = {
+        characters: %i[comics events series stories],
+        comics: %i[characters creators events stories],
+        creators: %i[comics events series stories],
+        events: %i[characters comics creators series stories],
+        series: %i[characters comics creators events stories],
+        stories: %i[characters comics creators events series]
+      }.freeze
+
+      METHODS.each do |method, single_method|
+        define_method(method) do |args = {}|
+          api_call(method, args)
+        end
+
+        define_method(single_method) do |id, args = {}|
+          api_call("#{method}/#{id}", args)
+        end
+
+        SUBMETHODS[method].each do |submethod|
+          define_method("#{single_method}_#{submethod}") do |id, args = {}|
+            api_call("#{method}/#{id}/#{submethod}", args)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/marvel/api/http_service.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+
+module Marvel
+  class Api
+    module HTTPService
+      class << self
+        attr_accessor :faraday_middleware, :http_options
+
+        private
+
+        def faraday_options(options)
+          valid_options = %i[
+            request proxy ssl builder url parallel_manager params
+            headers builder_class
+          ]
+          Hash[options.select { |key, _| valid_options.include?(key) }]
+        end
+      end
+
+      self.http_options ||= {}
+
+      DEFAULT_MIDDLEWARE = proc do |builder|
+        builder.adapter Faraday.default_adapter
+      end
+
+      def self.make_request(request)
+        connection = Faraday.new(
+          request.server, faraday_options(request.options),
+          &(faraday_middleware || DEFAULT_MIDDLEWARE)
+        )
+        response = connection.send(request.verb, request.path, request.args)
+        Marvel::Api::Response.new(
+          status: response.status.to_i, headers: response.headers,
+          body: response.body
+        )
+      end
+    end
+  end
+end

data/lib/marvel/api/request.rb

@@ -0,0 +1,35 @@
+module Marvel
+  class Api
+    class Request
+      attr_reader :raw_path, :raw_args, :raw_options
+
+      GET = 'get'.freeze
+
+      def initialize(path:, args: {}, options: {})
+        @raw_path = path
+        @raw_args = args
+        @raw_options = options
+      end
+
+      def verb
+        GET
+      end
+
+      def path
+        "/v1/public/#{raw_path}"
+      end
+
+      def args
+        raw_args
+      end
+
+      def options
+        raw_options
+      end
+
+      def server
+        Marvel::Api::DEFAULT_SERVER
+      end
+    end
+  end
+end

data/lib/marvel/api/response.rb

@@ -0,0 +1,31 @@
+module Marvel
+  class Api
+    class Response
+      attr_reader :status, :headers, :body, :etag, :offset, :limit, :total,
+                  :count, :results
+
+      def initialize(status:, headers:, body:)
+        @status = status
+        @headers = headers
+        @body = body
+
+        parse_body
+      end
+
+      private
+
+      def parse_body
+        data = JSON.parse(body)
+
+        @etag = data['etag']
+        methods = %w[offset limit total count results]
+        methods.each do |method_name|
+          value = data['data'][method_name]
+          instance_variable_set(:"@#{method_name}", value)
+        end
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/marvel/api/version.rb

@@ -0,0 +1,5 @@
+module Marvel
+  class Api
+    VERSION = '0.1.0'.freeze
+  end
+end

data/marvel-api.gemspec

@@ -0,0 +1,35 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'marvel/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'marvel-api'
+  spec.version       = Marvel::Api::VERSION
+  spec.authors       = ['Krzysztof Wawer']
+  spec.email         = ['krzysztof.wawer@gmail.com']
+
+  spec.summary       = 'Interface to Marvel API'
+  spec.description   = 'Interface to Marvel API'
+  spec.homepage      = ''
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_runtime_dependency 'faraday'
+
+  spec.add_development_dependency 'bundler', '~> 1.14'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop', '0.48.1'
+  spec.add_development_dependency 'timecop', '~> 0.8'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

metadata

@@ -0,0 +1,186 @@
+--- !ruby/object:Gem::Specification
+name: marvel-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krzysztof Wawer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-04-09 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.14'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.5'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.48.1
+- !ruby/object:Gem::Dependency
+  name: timecop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.3'
+description: Interface to Marvel API
+email:
+- krzysztof.wawer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/marvel/api.rb
+- lib/marvel/api/api_methods.rb
+- lib/marvel/api/http_service.rb
+- lib/marvel/api/request.rb
+- lib/marvel/api/response.rb
+- lib/marvel/api/version.rb
+- marvel-api.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: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.1
+signing_key: 
+specification_version: 4
+summary: Interface to Marvel API
+test_files: []