dd-api 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 735af5fcc3da32f5a0e0c5b87f45253e70aa279f
+  data.tar.gz: 57e945702c70f0fdd10f8d2e01a62c4508d5c4d2
+SHA512:
+  metadata.gz: e5dd4938aec1ff0fda3cf046ad69c57650bd64f36de54d556ed17f147ca4da6b03bbec253aa7e18ae17858a046cda7e6dc0ffc820ea3009a6b4d7a262c3db75b
+  data.tar.gz: 094fb4ce8bed631a638cde92639216fdb1fc7e5d2ca2312f80bcb9fd027f5c81312353f55f5ea499587c25934f876207c1844e7b2578aa213197dcf61db7b4af

data/lib/dd-api.rb

@@ -0,0 +1,7 @@
+require 'dd-api/classes'
+require 'dd-api/init'
+require 'dd-api/api'
+require 'dd-api/version'
+require 'dd-api/errors'
+module DDAPI
+end

data/lib/dd-api/api.rb

@@ -0,0 +1,51 @@
+require 'rest-client'
+
+require 'dd-api/errors'
+
+# List of methods representing endpoints in Discord Dungeons's API
+module DDAPI::API
+  # Make an item image URL from the item image
+  def item_url(image)
+    "https://res.discorddungeons.me/images/#{image}"
+  end
+
+  def rget(endpoint, api_key, user_agent)
+    JSON.parse(RestClient.get("http://api.discorddungeons.me/#{endpoint}", :'X-Api-Key' => api_key, :'User-Agent' => user_agent))
+  end
+
+  def get(endpoint, app)
+    JSON.parse(RestClient.get("http://api.discorddungeons.me/#{endpoint}", :'X-Api-Key' => app.api_key, :'User-Agent' => app.user_agent))
+  end
+
+  def get_user(app, id)
+    get('user/'+id.to_s, app)['user']
+  end
+
+  def get_guild(app, id)
+    get('guild/'+id, app)['data']
+  end
+
+  def get_items(app, id)
+    get('item/'+id, app)['data']
+  end
+
+  def get_gitems(app, id)
+    get('gitem/'+id, app)['data']
+  end
+
+  def all_guilds(app)
+    get('all/guilds', app)['data']
+  end
+
+  def all_users(app)
+    get('all/users', app)['data']
+  end
+
+  def all_items(app)
+    get('all/items', app)['data']
+  end
+
+  def all_gitems(app)
+    get('all/gitems', app)['data']
+  end
+end

data/lib/dd-api/classes.rb

@@ -0,0 +1,247 @@
+require 'json'
+require 'htmlentities'
+
+require 'dd-api/api'
+require 'dd-api/init'
+
+# Objects essential to DRPG
+module DDAPI
+  # A Class that is bundled with an API key and a User Agent. Base of gem.
+  class App
+    # @return [String] The api key of the instance.
+    attr_accessor :api_key
+
+    # @return [String] The user agent of the instance.
+    attr_accessor :user_agent
+
+    include Init
+
+    def initialize(api_key, user_agent)
+        @api_key = api_key
+        @user_agent = user_agent
+    end
+  end
+  # Represents a DRPG user.
+  class User
+    # @return [Srting] The name of the user.
+    attr_accessor :name
+    alias_method :nickname, :name
+
+    # @return [Integer] How much health that user has
+    attr_accessor :hp
+    alias_method :health, :hp
+
+    # @return [Integer] How much deaths that user has
+    attr_accessor :deaths
+    alias_method :frags, :deaths
+
+    # @return [Integer] How much kills that user has
+    attr_accessor :kills
+
+    # @return [Integer] How much gold that user has
+    attr_accessor :gold
+
+    # @return [Integer] How much experience that user has
+    attr_accessor :xp
+    alias_method :experience, :xp
+
+    # @return [Integer] The level at that time, of the user.
+    attr_accessor :level
+    alias_method :lvl, :level
+
+    # @return [Integer] How much maximun health that user has
+    attr_accessor :max_hp
+    alias_method :max_health, :max_hp
+
+    # @return [Integer] The ID of the user.
+    attr_accessor :id
+
+    # @return [true, false] whether the user donated to Discord Dungeons or not.
+    attr_accessor :donated
+    alias_method :donated?, :donated
+
+    def initialize(data, app)
+      @data = data['data']
+      @id = data['id']
+      @name = @data['name']
+      @level = @data['level']
+      @hp = @data['hp']
+      @max_hp = @data['maxhp']
+      @gold = @data['gold']
+      @xp = @data['xp']
+      @kills = @data['kills']
+      @deaths = @data['deaths']
+      @weapon_id = @data['weapon']
+      @donated = @data['donate']
+      @guild = @data['guild']
+      @app = app
+    end
+
+    # @return [Guild, nil] the user's guild
+    def guild
+      if @guild != ""
+        @app.guild(@guild)
+      else
+        nil
+      end
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "#<DDAPI::User name=#{@name} id=#{@id} level=#{@level}>"
+    end
+  end
+  # Represents a DRPG guild.
+  class Guild
+    # @return [String] The name of the guild.
+    attr_accessor :name
+
+    # @return [User] The user object of the guild owner.
+    attr_accessor :owner
+    alias_method :leader, :owner
+
+    # @return [String] The description of the guild.
+    attr_accessor :description
+    alias_method :desc, :description
+
+    # @return [Integer] The amount gold in the guild.
+    attr_accessor :gold
+
+    # @return [Integer] The level of the guild.
+    attr_accessor :level
+    alias_method :lvl, :level
+
+    # @return [Integer] The ID of the guild.
+    attr_accessor :id
+
+    # @return [true, false] The icon of the guild.
+    attr_accessor :icon
+
+    def initialize(data, app)
+      @data = data
+      @gdata = data['guild']
+      @name = data['name']
+      @level = gdata['level']
+      @description = gdata['desc']
+      @gold = gdata['gold']
+      @icon = HTMLEntities.new.decode(gdata['icon'])
+      @id = data['id']
+      @members = gdata['members']
+      @owner = @app.user(gdata['owner'])
+      @app = app
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "#<DDAPI::Guild name=#{@name} id=#{@id} level=#{@level}>"
+    end
+  end
+  # Represents a DRPG item.
+  class Item
+    # @return [String] The name of the item.
+    attr_accessor :name
+
+    # @return [Integer, nil] The cost of the item. `nil` if not buyable.
+    attr_accessor :sell_price
+
+    # @return [String] The prefix name of the item.
+    attr_accessor :prefix
+
+    # @return [String] The plural name of the item.
+    attr_accessor :plural
+
+    # @return [String] The type of the item.
+    attr_accessor :type
+
+    # @return [String] The description of the item.
+    attr_accessor :description
+    alias_method :desc, :description
+
+    # @return [String] The image URL to the item.
+    attr_accessor :image
+
+    # @return [Integer] The level of the item.
+    attr_accessor :level
+    alias_method :lvl, :level
+
+    # @return [Integer] The ID of the item.
+    # attr_accessor :id
+
+    # @return [true, false] Whether the item is sellable.
+    attr_accessor :sellable
+
+    # @return [Integer, nil] The sell price of the item. `nil` if not sellable.
+    attr_accessor :sell_price
+
+    # @return [true, false] Whether the item is tradeable.
+    attr_accessor :tradeable
+
+    def initialize(data, app)
+      @data = data
+      @name = data['name']
+      @level = data['level']
+      @description = data['desc']
+      @type = data['type']
+      @image = API.image_url(data['image'])
+      #@id = data['id']
+      @prefix = data['prefix']
+      @prefix = data['plural']
+      @sellable = data['sellable']
+      @tradeable = data['tradeable']
+      @sell_price = data['sell'] == -1 ? nil : data['sell']
+      @cost = data['cost'] == -1 ? nil : data['cost']
+      @app = app
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "#<DDAPI::Item name=#{@name} id=#{@id} level=#{@level}>"
+    end
+  end
+  # Represents a DRPG guild item.
+  class Item
+    # @return [String] The name of the item.
+    attr_accessor :name
+
+    # @return [Integer, nil] The cost of the item. `nil` if not buyable.
+    attr_accessor :sell_price
+
+    # @return [String] The prefix name of the item.
+    attr_accessor :prefix
+
+    # @return [String] The plural name of the item.
+    attr_accessor :plural
+
+    # @return [String] The description of the item.
+    attr_accessor :description
+    alias_method :desc, :description
+
+    # @return [String] The image URL to the item.
+    attr_accessor :image
+
+    # @return [Integer] The level of the item.
+    attr_accessor :level
+    alias_method :lvl, :level
+
+    # @return [Integer] The ID of the item.
+    # attr_accessor :id
+
+    def initialize(data, app)
+      @data = data
+      @name = data['name']
+      @level = data['level']
+      @description = data['desc']
+      @image = API.image_url(data['image'])
+      #@id = data['id']
+      @prefix = data['prefix']
+      @prefix = data['plural']
+      @cost = data['cost'] == -1 ? nil : data['cost']
+      @app = app
+    end
+
+    # The inspect method is overwritten to give more useful output
+    def inspect
+      "#<DDAPI::Item name=#{@name} id=#{@id} level=#{@level}>"
+    end
+  end
+end

data/lib/dd-api/errors.rb

@@ -0,0 +1,20 @@
+module DDAPI
+  # Custom errors raised in various places
+  module Errors
+
+    # Raised when authorization is invalid or incorrect.
+    class InvalidAuthorization < RuntimeError
+      # Default message for this exception
+      def message
+        'API key/User Agent invalid!'
+      end
+    end
+    # Raised when a device is invalid or incorrect.
+    class ObjectNotFound < RuntimeError
+      # Default message for this exception
+      def message
+        'A various Object is not found with this ID!'
+      end
+    end
+  end
+end

data/lib/dd-api/init.rb

@@ -0,0 +1,34 @@
+require 'rest-client'
+
+require 'dd-api/api'
+require 'dd-api/classes'
+
+module DDAPI
+  # Initializer Module
+  module Init
+
+    # def users
+      # all_users(self).values.map { |guild| User.new(guild, self) }
+    # end
+
+    def guilds
+      API.all_guilds(self).values.map { |guild| Guild.new(guild, self) }
+    end
+
+    def items
+      API.all_items(self).values.map { |item| Item.new(item, self) }
+    end
+
+    def gitems
+      API.all_gitems(self).values.map { |gitem| GuildItem.new(gitem, self) }
+    end
+
+    def user(id)
+      User.new(API.get_user(self, id), self)
+    end
+
+    def guild(id)
+      Guild.new(API.get_guild(self, id), self)
+    end
+  end
+end

data/lib/dd-api/version.rb

@@ -0,0 +1,3 @@
+module DDAPI
+  VERSION = '0.0.2'
+end

metadata

@@ -0,0 +1,121 @@
+--- !ruby/object:Gem::Specification
+name: dd-api
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Snazzah
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-08-18 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: rest-client
+  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: htmlentities
+  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'
+description: Wrapper gem of Discord Dungeons API.
+email:
+- snazzah@discorddungeons.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/dd-api.rb
+- lib/dd-api/api.rb
+- lib/dd-api/classes.rb
+- lib/dd-api/errors.rb
+- lib/dd-api/init.rb
+- lib/dd-api/version.rb
+homepage: http://api.discorddungeons.me/docs/
+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.4.5.1
+signing_key: 
+specification_version: 4
+summary: Wrapper gem of Discord Dungeons API.
+test_files: []
+has_rdoc: