lita-destiny 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 273db0f6ec1165b2bfb680c9adb3dbb17784d983
-  data.tar.gz: 8a77938f5edd415ec959fe837f8f1d853c2b83e3
+  metadata.gz: 1001acb2f432e2829d2350b9b135e21ed25e15cb
+  data.tar.gz: 408334e7ac7d4c16764329f7eedbb0a68e24b231
 SHA512:
-  metadata.gz: 93111e093fb4d5001ad794df9017067859138d5611984921fcf2fbc8fa0be319d80eb2334b639afc6cf1d9692f7d815df084c461f4ccb0d8ec42b3c70b835ff8
-  data.tar.gz: 88f9029bc6439c23e1fe82f871acd8e9597c5d66eac40d3d8034293263a99642fc5762703bd9cabd2601d8e85636e57c2a9e42a9d26b95f16cdbebf36f871458
+  metadata.gz: b891fde418eace9f3d39800c42f9d0e5c6a3bf9eabf2013adc3387e19c4a46d82a0431326a150158aa0e67c56d791d269c250cd56c7b63be129ed853d2839eb6
+  data.tar.gz: a492befaf6f8be623437c46105001f3abe2c57f9a361b9c2af74e11926c4e8056426bd38f32b845a3898c3bccff3e708498ab4ed9ff0f1203be0a4d9520c6097

data/Gemfile

@@ -1,5 +1,3 @@
 source "https://rubygems.org"
 
-gemspec
-
-gem 'httparty'
+gemspec

data/README.md

@@ -1,6 +1,8 @@
 # lita-destiny
 
+[![Gem Version](https://badge.fury.io/rb/lita-destiny.svg)](http://badge.fury.io/rb/lita-destiny)
 [![Build Status](https://travis-ci.org/PDaily/lita-destiny.svg?branch=master)](https://travis-ci.org/PDaily/lita-destiny)
+[![Code Climate](https://codeclimate.com/github/PDaily/lita-destiny/badges/gpa.svg)](https://codeclimate.com/github/PDaily/lita-destiny)
 [![Coverage Status](https://coveralls.io/repos/PDaily/lita-destiny/badge.svg?branch=master)](https://coveralls.io/r/PDaily/lita-destiny?branch=master)
 
 Lita handler for interacting with the Destiny API

data/lib/destiny/{destiny_api.rb → base_api.rb}

@@ -1,25 +1,54 @@
 require 'httparty'
 
+# DestinyAPI module wrapper
 module DestinyAPI
+  # Base API Class
+  # 
+  # Usage:
+  # destiny = DestinyAPI::Base.new(api_token)
+  # 
   class Base
+    # Include HTTParty Module
     include HTTParty
+    # Auto-parse responses from Bungie as JSON
     format :json
+    # Set base uri
     base_uri 'www.bungie.net/platform/destiny/'
 
 
     # Init the Destiny API with Bungie API stored in ENV variable
-    # destiny = Destiny.new(api_token)
+    # 
+    # Usage:
+    #   destiny = DestinyAPI::Base.new('6971067dec36c6597cd57789a62f48f0')
+    # 
+    # Arguments:
+    #   api_token: (String)
+    # 
     def initialize(api_token)
       @headers = { 'X-API-Key' => api_token, 'Content-Type' => 'application/json' }
     end
 
-    # Pull the days advisor report from http://www.bungie.net/platform/destiny/advisors/
-    # destiny.advisors
+    # GET the days advisor report from http://www.bungie.net/platform/destiny/advisors/
+    # 
+    # Usage:
+    #   destiny.advisors
+    # 
     def advisors
       raw_data = self.class.get('/advisors', headers: @headers)
       parsed = raw_data.parsed_response['Response']['data']
     end
 
+    # GET the activity information from http://www.bungie.net/platform/destiny/manifest/activity/{activity_hash}/
+    # 
+    # Raw argument will return an unmodified respons from Bungie.
+    # 
+    # Usage:
+    #   destiny.activity('3508129769', false)
+    #   
+    # Arguments: 
+    #   activity_hash: (String)
+    #   raw: (Boolean)
+    #   
     def activity(activity_hash, raw=false)
       raw_data = self.class.get("/manifest/activity/#{activity_hash}").parsed_response['Response']['data']['activity']
       skulls = []
@@ -33,30 +62,38 @@ module DestinyAPI
       end
     end
 
-    # Pull the weekly nightfall info from http://www.bungie.net/platform/destiny/manifest/activity/#{activity_hash}
-    # Optional boolean argument, defaults to false from activity method to only return basic information for Lita bot.
+    # GET the weekly nightfall info from http://www.bungie.net/platform/destiny/manifest/activity/#{activity_hash}
+    # 
+    # Optional boolean argument.
     # 
-    # destiny.nightfall
+    # Usage:
+    #  destiny.nightfall(true)
+    #  
+    # Arguments:
+    #  raw: (boolean)
     # 
-    def nightfall(options={})
+    def nightfall(raw=false)
       nightfall_activity_hash = self.advisors['nightfallActivityHash']
-      activity(nightfall_activity_hash, boolean)
+      activity(nightfall_activity_hash, raw)
     end
 
-    # Pull the weekly nightfall info from http://www.bungie.net/platform/destiny/manifest/activity/#{activity_hash}
+    # GET the weekly nightfall info from http://www.bungie.net/platform/destiny/manifest/activity/#{activity_hash}
     # Returns an array of three items, only need one for the skulls and location.
     # 
     # Optional boolean argument, defaults to false from activity method to return basic information for Lita bot.
     # 
-    # destiny.weekly_strike(false)
+    # Usage:
+    #  destiny.weekly_strike(false)
+    #  
+    # Arguments:
+    #  raw: (boolean)
     # 
-    def weekly_strike(options={})
+    def weekly_strike(raw=false)
       heroic_strike_hashes = self.advisors['heroicStrikeHashes']
-      activity(heroic_strike_hashes[0], boolean)
+      activity(heroic_strike_hashes[0], raw)
     end
 
-    # Pull the weekly nightfall info from http://www.bungie.net/platform/destiny/manifest/activity/#{activity_hash}
-    #
+    # GET the weekly nightfall info from http://www.bungie.net/platform/destiny/manifest/activity/#{activity_hash}
     # 
     # No known endpoints.
     def arena(options={})
@@ -71,12 +108,28 @@ module DestinyAPI
     # Pull the days bounties
     def bounties
     end
-
+    
+    # GET information about a place, specifically a planet.
+    # 
+    # Usage:
+    #  destiny.place('3747705955')
+    #  
+    # Arguments:
+    #  place_hash: (String)
+    #  
     def place(place_hash)
       raw data = self.class.get('/manifest/place/#{place_hash}').parsed_response['Response']['data']['place']
       response = { place_name: raw_data['placeName'], place_desc: raw_data['placeDescription'] }
     end
 
+    # GET information about a destination, specifically a location on a planet.
+    # 
+    # Usage:
+    #  destiny.destination('518553403')
+    #  
+    # Arguments:
+    #  destination_hash: (String)
+    #  
     def destination(destination_hash)
       raw_data = self.class.get('/manifest/destination/#{destination_hash}').parsed_response['Response']['data']
       response = { dest_name: raw_data['destinationName'], dest_desc: raw_data['destinationDescription'] }

data/lib/lita/handlers/destiny.rb

@@ -1,37 +1,103 @@
 module Lita
   module Handlers
-    class Destiny < Handler
-      namespace "destiny"
-      # Bring in DestinyAPI module
-      include DestinyAPI
-      
+    class Destiny < Handler 
       # Required configuration attribute
-      config :api_key, type: String, required: true do 
+      config :api_key, type: String, required: true do
+        # Do validation against provided api_key, MUST be 32 chars.
         validate do |value|
+          # Raise error unless api_key is 32 chars.
            "must be 32 characters" unless value.respond_to?(:size) && value.size == 32
         end
       end
       
-            
-      # Set up our client
-      destiny_client = DestinyAPI::Base.new(config.api_key).call
+      # Bring in DestinyAPI module
+      include DestinyAPI
 
+      # Nightfall Route
+      route(/^!(nightfall)/i, :nightfall , help: { "!nightfall" => "Get this weeks nightfall description and skulls" })
       
-      route(/^!\w(.*)/i, :nightfall , help: { "!nightfall" => "Get this weeks nightfall description and skulls" })
+      # Weekly Strike Route
+      route(/^!(weekly)/i, :weekly , help: { "!weekly" => "Get this weeks nightfall description and skulls" })
       
-            
+      # Xur Route
+      route(/^!(xur)/i, :xur , help: { "!xur" => "Get Xur's inventory when availible" })
+      
+      # Nightfall Activity Method
+      # 
+      # Calls #build_activity_message(activity)
+      # where activity would be nightfall.
+      #     
       def nightfall(response)
+        # Set up our client
+        destiny_client = DestinyAPI::Base.new(api_key)
+        # Build the activity message with nightfall info
         build_activity_message(destiny_client.nightfall, response)
       end
       
-      # activity = { activityName: raw_data['activityName'], activityDescription: raw_data['activityDescription'], skulls: skulls }
+      # Weekly Strike Activity Method
+      # 
+      # Calls #build_activity_message(activity)
+      # where activity would be the weekly strike.
+      #      
+      def weekly(response)
+        # Set up our client
+        destiny_client = DestinyAPI::Base.new(api_key)
+        # Build the activity message with weekly info
+        build_activity_message(destiny_client.weekly_strike, response)
+      end
+      
+      # Xur Items Method
+      # 
+      # Calls #build_xur_message()
+      # Returns Xur inventory when availible.  
+      # 
+      def xur(response)
+        build_xur_message(response)
+      end
+      
+      # Begin private methods
+      # 
+      private
+      
+      # Set our api_key for calling in route methods.
+      # 
+      def api_key
+        config.api_key
+      end
+      
+      # Generalized Response Method
+      # 
+      # Used by activity methods to bring concise activity info
+      # into the chat.
+      # 
       def build_activity_message(activity, response)
-        activity = activity
-        response.reply("#{activity["activityName"]}\n #{activityDescription["activityDescription"]}\n #{skulls["skulls"]}")
+        # Set activity
+        activity_hash = activity
+        # Send response
+        response.reply("#{activity_hash[:activityName]}\n#{activity_hash[:activityDescription]}\nSkulls: #{activity_hash[:skulls].join(', ')}")
       end
-     
-    end
 
+      # Xur Response Method
+      # 
+      # Builds response to bring Xur items into chat.
+      # 
+      def build_xur_message(response)
+        # Set up our client
+        destiny_client = DestinyAPI::Base.new(api_key)
+        # Set xur to our clients xur method
+        xur = destiny_client.xur
+        # Check vendorDetails to see if anything is availible.
+        if xur[:vendorDetails].nil?
+          # If nothing, send to chat that he isn't there.
+          response.reply "Xur isn't in the tower right now."
+        else
+          # If something, send to chat what he is selling.
+          response.reply "Xur is selling: "
+        end
+      end
+    end
+    
+    # Register the handler
     Lita.register_handler(Destiny)
   end
 end

data/lib/lita-destiny.rb

@@ -1,13 +1,16 @@
 require "lita"
 
+# Bring in locales from '/locales/*.yml'
 Lita.load_locales Dir[File.expand_path(
   File.join("..", "..", "locales", "*.yml"), __FILE__
 )]
 
-require "destiny/destiny_api"
+# Require core files
+require "destiny/base_api"
 require "lita/handlers/destiny"
 
+# Require response templates
 Lita::Handlers::Destiny.template_root File.expand_path(
   File.join("..", "..", "templates"),
  __FILE__
-)
+)

data/lita-destiny.gemspec

@@ -1,6 +1,6 @@
 Gem::Specification.new do |spec|
   spec.name          = "lita-destiny"
-  spec.version       = "0.1.2"
+  spec.version       = "0.1.3"
   spec.authors       = ["PDaily"]
   spec.email         = ["pat.irwin4@gmail.com"]
   spec.description   = "Small lita.io handler for interacting with the Destiny API"
@@ -24,4 +24,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "rspec", "~> 3.0", ">= 3.0.0"
   spec.add_development_dependency "simplecov", "~> 0.10", ">= 0.10.0"
   spec.add_development_dependency "coveralls", "~> 0.8", ">= 0.8.1"
+  spec.add_development_dependency "codeclimate-test-reporter"
 end

data/spec/lita/handlers/destiny_spec.rb

@@ -1,14 +1,13 @@
 require "spec_helper"
 
 describe Lita::Handlers::Destiny, lita_handler: true do
-  let(:api_token) { 'abcd-1234567890-hWYd21AmMH2UHAkx29vb5c1Y' }
-  let(:config) { Lita::Adapters::Destiny.configuration_builder.build }
+  let(:api_key) { 'd319ebf361e9f4f28e65fa05ce1cf8d6' }
+  let(:config) { Lita::Handlers::Destiny.configuration_builder.build }
   
   before do
-    config.api_token = api_token
+    config.api_key = api_key
   end
   
   it { is_expected.to route_command("!nightfall").to(:nightfall)}
   
-  
 end

data/spec/spec_helper.rb

@@ -1,5 +1,9 @@
 require "simplecov"
 require "coveralls"
+require "codeclimate-test-reporter"
+
+CodeClimate::TestReporter.start
+
 SimpleCov.formatter = SimpleCov::Formatter::MultiFormatter[
   SimpleCov::Formatter::HTMLFormatter,
   Coveralls::SimpleCov::Formatter

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: lita-destiny
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - PDaily
@@ -178,6 +178,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.1
+- !ruby/object:Gem::Dependency
+  name: codeclimate-test-reporter
+  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'
 description: Small lita.io handler for interacting with the Destiny API
 email:
 - pat.irwin4@gmail.com
@@ -191,7 +205,7 @@ files:
 - LICENSE
 - README.md
 - Rakefile
-- lib/destiny/destiny_api.rb
+- lib/destiny/base_api.rb
 - lib/lita-destiny.rb
 - lib/lita/handlers/destiny.rb
 - lita-destiny.gemspec