thanos 0.0.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b1c377d5692ad359f53e9f189dd022cc56dbca64
-  data.tar.gz: 1546b50f176cdf9a2ef0cafa2b25fa5e00042357
+  metadata.gz: 58c72c78f9641598e36bf626effe7083335a9474
+  data.tar.gz: c522ffb61ef7353312f52923632b477cba61970f
 SHA512:
-  metadata.gz: 0ecf2d60e2474e27b6a50323e36d9aafc13a9b6ad51525a427bf1b1e513e92d0d8566af07a21fdc452bee814bb6372bb9cd0a2ac9b44c9818c591a3042fe436a
-  data.tar.gz: f8c681752bdce3d10c0b07d57888c0b84c0f1e120f50a1794a7303844aae35728ee77c22bb46e4a1242f4140d9e9cdf2ecdc2b069462aa4b35ea2f1e5664da09
+  metadata.gz: c6ac2ec186937f8af4b389cf4b86ed6fc6e96ad6dd6285012d6749e607f3049447e7e0c29837ecaa6c964c0bf51c8cddd909da6545ac50ba0bd00d33a31cd039
+  data.tar.gz: 4a56a1814e30752f79d2bdcb267ee845799b9efd60b76b87905a1b66f823cd33f83a963a4341cbb7d178ae0937053e453dc688725fdb9364e8b7c08150aaced9

data/.gitignore

@@ -0,0 +1,15 @@
+/.idea/
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/rdoc/
+/pkg/
+/spikes/api_keys.yml
+/spikes/test_thanos.rb
+/spec/examples.txt
+/spec/reports/
+/tmp/
+.DS_Store

data/.hound.yml

@@ -0,0 +1,64 @@
+AllCops:
+  Exclude:
+    - thanos.gemspec
+    - spikes/*.rb
+    - spec/**/*
+
+# C: Missing top-level module documentation comment.
+Style/Documentation:
+  Enabled: false
+
+# C: Prefer reduce over inject.
+Style/CollectionMethods:
+  PreferredMethods:
+    reduce: 'inject'
+
+# C: Use each_with_object instead of inject.
+Style/EachWithObject:
+  Enabled: false
+
+# C: Removing the preference for string single quotes
+Style/StringLiterals:
+  Enabled: false
+
+#C: Prefer fail over raise
+Style/SignalException:
+  Enabled: false
+
+Style/TrailingComma:
+  EnforcedStyleForMultiline: comma
+
+# This never works for validations
+Style/AlignHash:
+  EnforcedLastArgumentHashStyle: ignore_implicit
+
+# align multi-line params with previous line
+Style/AlignParameters:
+  EnforcedStyle: with_fixed_indentation
+
+# indent `when` clause one step from `case`
+Style/CaseIndentation:
+  IndentOneStep: true
+
+# don't force crappy var names for reduce/inject loops...
+Style/SingleLineBlockParams:
+  Enabled: false
+
+# for method chains, keep the dot with the method name
+Style/DotPosition:
+  EnforcedStyle: leading
+
+# stop nesting so hard.
+Metrics/BlockNesting:
+  Max: 2
+
+# short methods, man...
+Metrics/MethodLength:
+  Enabled: false
+
+# fewer parameters
+Metrics/ParameterLists:
+  Max: 3
+
+Metrics/AbcSize:
+  Enabled: false

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,2 @@
+inherit_from:
+  - .hound.yml

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.6

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

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

data/LICENSE.txt

@@ -1,22 +1,21 @@
-Copyright (c) 2013 Jeff Nyman
+The MIT License (MIT)
 
-MIT License
+Copyright (c) 2015 Jeff Nyman
 
-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:
+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 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.
+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

@@ -1,36 +1,113 @@
+![Thanos](http://testerstories.com/files/Thanos.Show.Me.jpg)
+
 # Thanos
 
-[![Build Status](https://secure.travis-ci.org/jnyman/thanos.png)](http://travis-ci.org/jnyman/thanos)
-[![Coverage Status](https://coveralls.io/repos/jnyman/thanos/badge.png?branch=master)](https://coveralls.io/r/jnyman/thanos?branch=master)
-[![Code Climate](https://codeclimate.com/github/jnyman/thanos.png)](https://codeclimate.com/github/jnyman/thanos)
-[![Dependency Status](https://gemnasium.com/jnyman/thanos.png)](https://gemnasium.com/jnyman/thanos)
+On 31 January 2014 Marvel Comics [put out a press release](http://marvel.com/news/comics/21871/marvel_announces_the_release_of_the_api_program) announcing an API connecting to Marvel's database of comics, characters, and creators.
 
-[![endorse](https://api.coderwall.com/jnyman/endorsecount.png)](https://coderwall.com/jnyman)
+Thanos provides a very simple wrapper for the [Marvel API](http://developer.marvel.com/) and attempts to make that API easily queryable by providing qualifier objects that allow a consumer of the API to drill down into specific details.
 
-TODO: Write a gem description
+Thanos is a [Marvel super-villain](https://en.wikipedia.org/wiki/Thanos) and plays a large role in the current [Marvel cinematic universe](http://marvelcinematicuniverse.wikia.com/wiki/Thanos). Thanos has routinely teamed up with Death in order to achieve universe-wide domination. As accomplishments go, that's moderately impressive, to say the least.
 
 ## Installation
 
-Add this line to your application's Gemfile:
+To get the latest stable release, add this line to your application's Gemfile:
+
+```ruby
+gem 'thanos'
+```
 
-    gem 'thanos'
+To get the latest code:
 
-And then execute:
+```ruby
+gem 'thanos', git: https://github.com/jnyman/thanos
+```
+
+After doing one of the above, execute the following command:
 
     $ bundle
 
-Or install it yourself as:
+You can, of course, just install the gem directly like this:
 
     $ gem install thanos
 
 ## Usage
 
-TODO: Write usage instructions here
+### Setting Up the Client
+
+You need API credentials, which is a public and private key pair. You can get yours at the [Marvel Developer Portal](http://developer.marvel.com). These are required to configure and instantiate a Thanos client.
+
+```ruby
+require 'thanos'
+
+Thanos.authenticate do |key|
+  key.public_api_key = 'your public key'
+  key.private_api_key = 'your private key'
+end
+
+client = Thanos::Client.new
+```
+
+Make sure you put in your own public and private keys that you were assigned. The `client` variable will now hold a `Thanos::Client` instance that you can call endpoint methods on.
+
+## API Access
+
+Thanos is a wrapper around the API resources and is designed to provide a simple interface that allows you to communicate with the API without having to know the structure of the information returned by the API.
+
+Here is a full example of getting information about a character, assuming you have a `client` instance as shown above:
+
+```ruby
+hulk = client.characters.find_by_name 'Hulk'
+
+puts hulk.id
+puts hulk.name
+puts hulk.description
+puts hulk.resource_uri
+puts hulk.thumbnail.path
+puts hulk.thumbnail.extension
+puts hulk.thumbnail.full_path
+
+puts hulk.urls.first.url
+puts hulk.urls.first.type
+
+hulk.urls.each do |link|
+  puts "Url: #{link.url}"
+end
+
+hulk.comics.each do |comic|
+  puts "Comic: #{comic.name}"
+end
+
+hulk.stories.each do |story|
+  puts "Story: #{story.name}"
+end
+
+hulk.events.each do |event|
+  puts "Event: #{event.name}"
+end
+
+hulk.series.each do |series|
+  puts "Series: #{series.name}"
+end
+```
+
+This shows you that you can call various attributes of the resource -- in this case a `character` -- and display information about the resource (such as `name` and `description`) as well as information related to the resource, such as a list of `events` or `series` that the character was involved in.
 
 ## Contributing
 
-1. Fork it
-2. Create your feature branch (`git checkout -b my-new-feature`)
-3. Commit your changes (`git commit -am 'Add some feature'`)
-4. Push to the branch (`git push origin my-new-feature`)
-5. Create new Pull Request
+Bug reports and pull requests are welcome on GitHub at [https://github.com/jnyman/thanos](https://github.com/jnyman/thanos). While Thanos wants to create a universe of death, despair and destruction, this project is intended to be a safe, welcoming space for collaboration. As such, contributors are very much welcome but are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+To contribute to Thanos:
+
+1. [Fork the project](http://gun.io/blog/how-to-github-fork-branch-and-pull-request/).
+2. Create a feature branch. (`git checkout -b my-new-feature`)
+3. Commit your changes. (`git commit -am 'new feature'`)
+4. Push the branch. (`git push origin my-new-feature`)
+5. Create a new [pull request](https://help.github.com/articles/using-pull-requests).
+
+## Author
+
+* [Jeff Nyman](http://testerstories.com)
+
+## 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,16 @@
+require 'bundler/gem_tasks'
+require 'rdoc/task'
+require 'rubocop/rake_task'
+require 'rspec/core/rake_task'
+
+RuboCop::RakeTask.new
+RSpec::Core::RakeTask.new(:spec)
+
+Rake::RDocTask.new do |rdoc|
+  rdoc.rdoc_dir = 'doc'
+  rdoc.main = 'README.md'
+  rdoc.title = "Thanos #{Thanos::VERSION}"
+  rdoc.rdoc_files.include('README*', 'lib/**/*.rb')
+end
+
+task default: [:spec, :rubocop]

data/bin/console

@@ -0,0 +1,13 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'thanos'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+require 'pry'
+Pry.start
+
+# require 'irb'
+# IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/thanos.rb

@@ -1,9 +1,14 @@
 require 'thanos/version'
+require 'thanos/authentication'
+require 'thanos/client'
 
 module Thanos
-  
-  def self.version
-    "Thanos v#{Thanos::VERSION}"
+  class << self
+    attr_accessor :authentication
+
+    def authenticate
+      self.authentication ||= Authentication.new
+      yield(authentication)
+    end
   end
-  
 end

data/lib/thanos/api/authentication.rb

@@ -0,0 +1,19 @@
+require 'digest/md5'
+require 'thanos/authentication'
+
+module Thanos
+  module API
+    class Authentication
+      class << self
+        def get
+          public_api_key = Thanos.authentication.public_api_key
+          private_api_key = Thanos.authentication.private_api_key
+          timestamp = Time.now.to_i.to_s
+          hash = Digest::MD5.hexdigest(
+            timestamp + private_api_key + public_api_key)
+          { ts: timestamp, apikey: public_api_key, hash: hash }
+        end
+      end
+    end
+  end
+end

data/lib/thanos/api/client.rb

@@ -0,0 +1,26 @@
+require 'rest_client'
+require 'thanos/api/response'
+require 'thanos/api/authentication'
+
+module Thanos
+  module API
+    class Client
+      API_VERSION = 'v1'
+      API_ENDPOINT = 'http://gateway.marvel.com'
+
+      def get(resource, options)
+        url = "#{endpoint}/#{resource}"
+        response = RestClient.get(url, params: options.merge(authentication))
+        Thanos::API::Response.new(response)
+      end
+
+      def endpoint
+        "#{API_ENDPOINT}/#{API_VERSION}/public"
+      end
+
+      def authentication
+        Authentication.get
+      end
+    end
+  end
+end

data/lib/thanos/api/response.rb

@@ -0,0 +1,16 @@
+require 'json'
+
+module Thanos
+  module API
+    class Response
+      attr_reader :code, :status, :data
+
+      def initialize(raw_response)
+        response = JSON.parse(raw_response)
+        @code = response['code'].to_i
+        @status = response['status']
+        @data = response['data']
+      end
+    end
+  end
+end

data/lib/thanos/authentication.rb

@@ -0,0 +1,5 @@
+module Thanos
+  class Authentication
+    attr_accessor :public_api_key, :private_api_key
+  end
+end

data/lib/thanos/client.rb

@@ -0,0 +1,21 @@
+require 'thanos/finders/character_finder'
+require 'thanos/finders/series_finder'
+require 'thanos/finders/event_finder'
+require 'thanos/finders/comic_finder'
+require 'thanos/finders/story_finder'
+require 'thanos/finders/creator_finder'
+
+module Thanos
+  class Client
+    attr_reader :characters, :series, :events, :comics, :stories, :creators
+
+    def initialize
+      @characters = Thanos::CharacterFinder.new
+      @series = Thanos::SeriesFinder.new
+      @events = Thanos::EventFinder.new
+      @comics = Thanos::ComicFinder.new
+      @stories = Thanos::StoryFinder.new
+      @creators = Thanos::CreatorFinder.new
+    end
+  end
+end