comic_vine-api 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: facbc48e025db55e56100c30fee204969f94018c
+  data.tar.gz: 9e0c886440158d99d5cb03cb0d401c701caae08b
+SHA512:
+  metadata.gz: 96c184849dbf461edd709e98ad1c21e035298bd4080c133ed00bd63910868e9c03120af840fafd80f916a293ef54022ac559e646f3e8c994b89ef3b15dbf314d
+  data.tar.gz: 1ef088063d1c51d1fbf42b738893ddbea62d9b8c2408a40ab3157adb0ab47447377b8bfbb8c037c831200c8c97e667b721f30b3f862389eb50b15c91b03fffdd

data/.gitignore

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

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 comic_vine-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,123 @@
+# ComicVine::Api
+
+[![Gem Downloads](https://img.shields.io/gem/dt/comic_vine-api.svg)](https://rubygems.org/gems/comic_vine-api)
+[![Build Status](https://travis-ci.org/comics-apps/comic_vine-api.svg?branch=master)](https://travis-ci.org/comics-apps/comic_vine-api)
+[![Code Climate](https://codeclimate.com/github/comics-apps/comic_vine-api.svg)](https://codeclimate.com/github/comics-apps/comic_vine-api)
+
+A simple ComicVine API client for Ruby, inspired by the koala's gem style.
+
+This gem contains several advantages over other API clients:
+* unlike with `comic_vine` gem, you can fetch series list
+* you can write own http service class which can use different gem than `faraday`
+* response is returned as pure Hash instead of mapping to different object
+* default http service class allows you to override http options like proxy settings.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'comic_vine-api'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install comic_vine-api
+
+## Usage
+
+```ruby
+api_key = 'foo'
+options = {}
+service = ComicVine::Api.new(api_key, **options)
+```
+
+There are two static methods:
+
+* search
+
+```ruby
+service.search(...)
+```
+
+* types
+
+```ruby
+service.types
+```
+
+Rest of methods, for resources are creating dynamically. If API some method will change you can call `#redefine_api_methods` which recreate method from `types` API endpoint.
+ 
+Gem provide also universal method which allows you to create custome 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
+
+Dynamic methods:
+
+* `character(id, args)`
+* `characters(args)`
+* `chat(id, args)`
+* `chats(args)`
+* `concept(id, args)`
+* `concepts(args)`
+* `episode(id, args)`
+* `episodes(args)`
+* `issue(id, args)`
+* `issues(args)`
+* `location(id, args)`
+* `locations(args)`
+* `movie(id, args)`
+* `movies(args)`
+* `object(id, args)`
+* `objects(args)`
+* `origin(id, args)`
+* `origins(args)`
+* `person(id, args)`
+* `people(args)`
+* `power(id, args)`
+* `powers(args)`
+* `promo(id, args)`
+* `promos(args)`
+* `publisher(id, args)`
+* `publishers(args)`
+* `series(id, args)`
+* `series_list(args)`
+* `story_arc(id, args)`
+* `story_arcs(args)`
+* `team(id, args)`
+* `teams(args)`
+* `video(id, args)`
+* `videos(args)`
+* `video_type(id, args)`
+* `video_types(args)`
+* `video_category(id, args)`
+* `video_categories(args)`
+* `volume(id, args)`
+* `volumes(args)`
+
+Check official API docs what arguments you can use: http://comicvine.gamespot.com/api/documentation
+
+
+## Development
+
+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/comic_vine-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/comic_vine-api.gemspec

@@ -0,0 +1,32 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'comic_vine/api/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'comic_vine-api'
+  spec.version       = ComicVine::Api::VERSION
+  spec.authors       = ['Krzysztof Wawer']
+  spec.email         = ['krzysztof.wawer@gmail.com']
+
+  spec.summary       = 'Interface to ComicVine API'
+  spec.description   = 'Interface to ComicVine 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 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.5'
+  spec.add_development_dependency 'rubocop'
+  spec.add_development_dependency 'vcr', '~> 3.0'
+  spec.add_development_dependency 'webmock', '~> 2.3'
+end

data/config/types.json

@@ -0,0 +1,102 @@
+[
+  {
+    "detail_resource_name": "character",
+    "list_resource_name": "characters",
+    "id": 4005
+  },
+  {
+    "detail_resource_name": "chat",
+    "list_resource_name": "chats",
+    "id": 2450
+  },
+  {
+    "detail_resource_name": "concept",
+    "list_resource_name": "concepts",
+    "id": 4015
+  },
+  {
+    "detail_resource_name": "episode",
+    "list_resource_name": "episodes",
+    "id": 4070
+  },
+  {
+    "detail_resource_name": "issue",
+    "list_resource_name": "issues",
+    "id": 4000
+  },
+  {
+    "detail_resource_name": "location",
+    "list_resource_name": "locations",
+    "id": 4020
+  },
+  {
+    "detail_resource_name": "movie",
+    "list_resource_name": "movies",
+    "id": 4025
+  },
+  {
+    "detail_resource_name": "object",
+    "list_resource_name": "objects",
+    "id": 4055
+  },
+  {
+    "detail_resource_name": "origin",
+    "list_resource_name": "origins",
+    "id": 4030
+  },
+  {
+    "detail_resource_name": "person",
+    "list_resource_name": "people",
+    "id": 4040
+  },
+  {
+    "detail_resource_name": "power",
+    "list_resource_name": "powers",
+    "id": 4035
+  },
+  {
+    "detail_resource_name": "promo",
+    "list_resource_name": "promos",
+    "id": 1700
+  },
+  {
+    "detail_resource_name": "publisher",
+    "list_resource_name": "publishers",
+    "id": 4010
+  },
+  {
+    "detail_resource_name": "series",
+    "list_resource_name": "series_list",
+    "id": 4075
+  },
+  {
+    "detail_resource_name": "story_arc",
+    "list_resource_name": "story_arcs",
+    "id": 4045
+  },
+  {
+    "detail_resource_name": "team",
+    "list_resource_name": "teams",
+    "id": 4060
+  },
+  {
+    "detail_resource_name": "video",
+    "list_resource_name": "videos",
+    "id": 2300
+  },
+  {
+    "detail_resource_name": "video_type",
+    "list_resource_name": "video_types",
+    "id": 2320
+  },
+  {
+    "detail_resource_name": "video_category",
+    "list_resource_name": "video_categories",
+    "id": 2320
+  },
+  {
+    "detail_resource_name": "volume",
+    "list_resource_name": "volumes",
+    "id": 4050
+  }
+]

data/lib/comic_vine/api/api_methods.rb

@@ -0,0 +1,63 @@
+module ComicVine
+  class Api
+    module ApiMethods
+      def types
+        api_call('types', {})
+      end
+
+      def search(args = {})
+        api_call('search', args)
+      end
+
+      def initial_define_api_methods
+        # types data from API has bug(s), in json file data are fixed
+        path = File.join(File.dirname(__FILE__), '../../../config/types.json')
+        stored_types = JSON.parse(File.read(path))
+        define_api_methods(stored_types)
+      end
+
+      # Maybe in future ComicVine devs will fix bug in types,
+      # when it happened then you can still work with new endpoints,
+      # just run #redefine_api_methods method,
+      def redefine_api_methods
+        define_api_methods(types.results, true)
+      end
+
+      private
+
+      def define_api_methods(stored_types, redefine = false)
+        stored_types.each do |type|
+          define_collection_method(type, redefine)
+          define_entity_method(type, redefine)
+        end
+      end
+
+      def define_collection_method(type, redefine)
+        resource_name = type['list_resource_name']
+        optional_define_api_method(resource_name, redefine) do |method_name|
+          self.class.send(:define_method, method_name) do |args = {}|
+            api_call(resource_name, args)
+          end
+        end
+      end
+
+      def define_entity_method(type, redefine)
+        resource_name = type['detail_resource_name']
+        optional_define_api_method(resource_name, redefine) do |method_name|
+          self.class.send(:define_method, method_name) do |id, args = {}|
+            path = "#{resource_name}/#{type['id']}-#{id}"
+            api_call(path, args)
+          end
+        end
+      end
+
+      def optional_define_api_method(type, redefine)
+        return if redefine || (!redefine && self.class.method_defined?(type))
+
+        method_name = :"#{type}_#{Time.now.to_f.to_s.tr('.', '_')}"
+        yield(method_name)
+        self.class.send(:alias_method, type.to_sym, method_name)
+      end
+    end
+  end
+end

data/lib/comic_vine/api/http_service.rb

@@ -0,0 +1,39 @@
+require 'faraday'
+
+module ComicVine
+  class Api
+    module HTTPService
+      class << self
+        attr_accessor :faraday_middleware, :http_options
+
+        private
+
+        def faraday_options(options)
+          valid_options = [
+            :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)
+        ComicVine::Api::Response.new(
+          status: response.status.to_i, headers: response.headers,
+          body: response.body
+        )
+      end
+    end
+  end
+end

data/lib/comic_vine/api/request.rb

@@ -0,0 +1,37 @@
+module ComicVine
+  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
+        "/api/#{raw_path}/"
+      end
+
+      def args
+        {
+          format: :json
+        }.merge(raw_args)
+      end
+
+      def options
+        raw_options
+      end
+
+      def server
+        "http://#{ComicVine::Api::DEFAULT_SERVER}"
+      end
+    end
+  end
+end

data/lib/comic_vine/api/response.rb

@@ -0,0 +1,31 @@
+module ComicVine
+  class Api
+    class Response
+      attr_reader :raw_response, :status, :headers, :body, :error, :limit,
+                  :offset, :number_of_page_results, :number_of_total_results,
+                  :status_code, :results, :version
+
+      def initialize(status:, headers:, body:)
+        @status = status
+        @headers = headers
+        @body = body
+
+        parse_body
+      end
+
+      private
+
+      def parse_body
+        data = JSON.parse(body)
+        methods = %w(error limit offset number_of_page_results
+                     number_of_total_results status_code results version)
+
+        methods.each do |method_name|
+          instance_variable_set(:"@#{method_name}", data[method_name])
+        end
+      rescue
+        nil
+      end
+    end
+  end
+end

data/lib/comic_vine/api/version.rb

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

data/lib/comic_vine/api.rb

@@ -0,0 +1,37 @@
+require 'json'
+
+require 'comic_vine/api/api_methods'
+require 'comic_vine/api/http_service'
+require 'comic_vine/api/request'
+require 'comic_vine/api/response'
+require 'comic_vine/api/version'
+
+module ComicVine
+  class Api
+    include ApiMethods
+
+    class << self
+      attr_accessor :http_service
+    end
+
+    self.http_service = HTTPService
+
+    DEFAULT_SERVER = 'comicvine.gamespot.com'.freeze
+
+    attr_reader :api_key, :options
+
+    def initialize(api_key, options = {})
+      @api_key = api_key
+      @options = options
+
+      initial_define_api_methods
+    end
+
+    def api_call(path, args, options = {})
+      request = Request.new(
+        path: path, args: args.merge(api_key: api_key), options: options
+      )
+      self.class.http_service.make_request(request)
+    end
+  end
+end

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification
+name: comic_vine-api
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Krzysztof Wawer
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-03-05 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: 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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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 ComicVine API
+email:
+- krzysztof.wawer@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- comic_vine-api.gemspec
+- config/types.json
+- lib/comic_vine/api.rb
+- lib/comic_vine/api/api_methods.rb
+- lib/comic_vine/api/http_service.rb
+- lib/comic_vine/api/request.rb
+- lib/comic_vine/api/response.rb
+- lib/comic_vine/api/version.rb
+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 ComicVine API
+test_files: []