little_light 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d4f25a0468bca3c68040660b4151aedddeca4b42
+  data.tar.gz: dfc1923f1a9bab96411fa3ed727ffa3c258c8c2c
+SHA512:
+  metadata.gz: e176ca16ed21d0475539a454ec80e78e0b1c3ab22b0e31f1206cedee6925aca31b59b5b3ac1f763b93720a79f06e3ec79b56410b545b1c8b432655e97b89aa78
+  data.tar.gz: 46304b9e03e494d2322870f11f23a2da875855ad4462a0ae349b70594b26ad9881ff763588c56f1b60340df74949170a6780c7e0f858df8d3d087559ef2c52d4

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+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, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at brendanekane@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in little_light.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Brendan
+
+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,53 @@
+# LittleLight
+
+LittleLight is a simple wrapper written in Ruby to make API calls to the Destiny 2 database. The majority of methods only require you to supply an api-key, however some methods require Oauth2 authentication (which is not provided by this gem in any capacity).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'little_light'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install little_light
+
+## Usage
+
+A prerequisite to using this gem is having a valid api-key from Bungie. Without an api-key you will not be able to call any methods successfully.
+
+To start off you need to instantiate the Client and supply it with an api-key as a parameter.
+```ruby
+client = LittleLight::Client("api-key")
+```
+Once you have instantiated the client you can call any methods in the lib folder on the client with the required parameters
+
+ex/
+```ruby
+client.search_bungie_net_by_username("robbinthehood") => returns an object with of all usernames containing the string "robbinthehood"
+```
+You can find all the methods available to use in the lib folder, along with comments about what you should expect it to return, required params, as well as some links to destiny api docs for certain params.
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. 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/brendanekane/little_light. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the LittleLight project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/little_light/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "little_light"
+
+# 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.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

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

data/lib/little_light.rb

@@ -0,0 +1,11 @@
+require "little_light/version"
+require 'little_light/client'
+require 'little_light/user'
+require 'little_light/clan'
+require 'little_light/vendor'
+
+module LittleLight
+  def self.new(options={})
+    LittleLight::Client.new(options)
+  end
+end

data/lib/little_light/clan.rb

@@ -0,0 +1,72 @@
+module LittleLight
+  module Clan
+
+    #groupType 0 - general, 1 - clan
+
+    #both get_clan_by methods return exactly the same thing, just different ways of
+    #accessing information through params
+    def get_clan_by_name(groupName, groupType)
+      if groupName.match(" ")
+        groupName = groupName.split(" ").map {|el| el += "%20"}.join("")
+      end
+      data = self.class.get(
+        "/GroupV2/Name/#{groupName}/#{groupType}/",
+         headers: @headers
+       )
+    end
+
+    def get_clan_by_id(groupId)
+      data = self.class.get("/GroupV2/#{groupId}/",
+        headers: @headers)
+    end
+
+    # returns a list of available optional conserations for the clan
+    def get_clan_optional_convos(groupId)
+      data = self.class.get(
+        "/GroupV2/{groupId}/OptionalConversations/",
+        headers: @headers
+      )
+    end
+
+    # returns a list of active members in the clan
+    def get_clan_members(groupId)
+      data = self.class.get(
+        "/GroupV2/{groupId}/Members/",
+        headers: @headers
+      )
+    end
+
+    # returns a list of banned members
+    def get_banned_clan_members(groupId)
+      data = self.class.get(
+        "GroupV2/{groupId}/Banned/",
+        headers: @headers
+      )
+    end
+
+    # returns a hash of whether the rewards were unlocked or picked up along with their boolean state
+    def get_clan_weekly_state(groupId)
+      data = self.class.get(
+        "/Destiny2/Clan/#{groupId}/WeeklyRewardState/",
+         headers: @headers
+       )
+    end
+
+    # both of the next two clan member functions take an optional param for page number
+    # (which limits to 50 elements per page). Not sure how to implement that currently.
+    def get_clan_admin_founders(groupId)
+      data = self.class.get(
+        "/GroupV2/#{groupId}/AdminsAndFounder/",
+         headers: @headers
+       )
+    end
+
+
+    def get_clan_members(groupId)
+      data = self.class.get(
+        "/GroupV2/#{groupId}/Members/",
+         headers: @headers
+       )
+    end
+  end
+end

data/lib/little_light/client.rb

@@ -0,0 +1,21 @@
+require 'httparty'
+require_relative 'user'
+require_relative 'clan'
+require_relative 'vendor'
+
+module LittleLight
+  class Client
+    include HTTParty
+    format :json
+
+    base_uri 'www.bungie.net/Platform'
+
+    include User
+    include Clan
+    include Vendor
+
+    def initialize(api_key)
+      @headers = {"x-api-key" => api_key,  "Content-Type" => "application/json" }
+    end
+  end
+end

data/lib/little_light/user.rb

@@ -0,0 +1,138 @@
+module LittleLight
+  module User
+    def get_bungie_net_profile(bungieMembershipId)
+      data = self.class.get(
+        "/User/GetBungieNetUserById/#{bungieMembershipId}/",
+         headers: @headers
+       )
+    end
+
+
+    # returns a JSON object of potential users that match the given username
+    # gives basic overview of returned users, returns bungie.net membershipID but no Destiny membershipID
+    def search_bungie_net_by_username(username)
+      data = self.class.get(
+        "/User/SearchUsers?q=#{username}",
+         headers: @headers
+       )
+    end
+
+
+    # returns only the exact user on the given platform or nothing
+    # basically just gives the Destiny membershipID
+    # displayName is either GamerTag or PSN Name
+    def search_destiny_player(displayName, membershipType)
+      data = self.class.get(
+        "/Destiny2/SearchDestinyPlayer/#{membershipType}/#{displayName}/",
+         headers: @headers
+       )
+    end
+
+    # basically returns a combination of both search_bungie_net_by_username && search_destiny_player however
+    # the destinyMembershipId is needed to access this endpoint (which you can only really get from search_destiny_player)
+    def get_user_by_membership(destinyMembershipId, membershipType)
+      data = self.class.get(
+        "/User/GetMembershipsById/#{destinyMembershipId}/#{membershipType}/",
+         headers: @headers
+       )
+    end
+
+    # returns the same as the method above, doesn't require any parms to be passed in but does require a user to be
+    # signed in via Oauth2
+    def get_current_user_membership
+      data = self.class.get(
+        "/User/GetMembershipsForCurrentUser/",
+        headers: @headers
+      )
+    end
+
+
+    def get_user_themes
+      data = self.class.get(
+        "/User/GetAvailableThemes/",
+        headers: @headers
+      )
+    end
+
+
+    def get_user_partnerships(destinyMembershipId)
+      data = self.class.get(
+        "/User/#{destinyMembershipId}/Partnerships/",
+        headers: @headers
+       )
+    end
+
+
+    def get_linked_profiles(destinyMembershipId, membershipType)
+      data = self.class.get(
+        "/Destiny2/#{membershipType}/Profile/#{destinyMembershipId}"\
+        "/LinkedProfiles/",
+         headers: @headers
+       )
+    end
+
+
+    #groupType 0 - general, 1 - clan
+    #filter 0 - All, 1 - Founded, 2 - Not Founded
+    def get_groups_for_user(destinyMembershipId, membershipType, groupType, filter)
+      data = self.class.get(
+        "/GroupV2/User/#{membershipType}/#{destinyMembershipId}"\
+        "/#{filter}/#{groupType}/",
+         headers: @headers
+       )
+    end
+    # component query string 100 - profile, 200 - characters, 300 - items, 400 - vendors, 500 - kiosks
+    # https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType
+    #                 ^^^ Link to full list of components ^^^
+
+
+    # only 100 & 200 query strings will produce results here
+    def get_destiny_profile(destinyMembershipId, membershipType, component)
+      data = self.class.get(
+        "/Destiny2/#{membershipType}/Profile/#{destinyMembershipId}"\
+        "?components=#{component}",
+         headers: @headers
+       )
+    end
+
+
+    # only 200 query strings will produce results here
+    # for query strings that return a JSON object that has a key of
+    # privacy pointing to 2 - means that user need to be authenticated via
+    # OAuth 2.0 or user has privacy settings on.
+    # No real plans to implement OAuth in this gem.
+    def get_character(destinyMembershipId, membershipType, characterId, component)
+      data = self.class.get(
+        "/Destiny2/#{membershipType}/Profile/#{destinyMembershipId}"\
+        "/Character/#{characterId}?components=#{component}",
+         headers: @headers
+       )
+    end
+
+    # returns the stats of a specific item instance
+    def get_item(destinyMembershipId, membershipType, itemInstanceId)
+      data = self.class.get(
+        "/Destiny2/{membershipType}/Profile/{destinyMembershipId}/Item/"\
+        "{itemInstanceId}/",
+        headers: @headers
+      )
+    end
+
+    # the next two get_user methods return info relevant to the specific clans they're in
+    # but are user methods not clan methods
+    def get_user_clan_theme
+      data = self.class.get(
+        "/GroupV2/GetAvailableThemes/",
+        headers: @headers
+      )
+    end
+
+
+    def get_user_clan_avatar
+      data = self.class.get(
+        "/GroupV2/GetAvailableAvatars/",
+        headers: @headers
+      )
+    end
+  end
+end

data/lib/little_light/vendor.rb

@@ -0,0 +1,29 @@
+module LittleLight
+  module Vendor
+
+    # this will return all possible vendors that have a rotating inventory.
+    # requires a components query string
+    # https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType
+
+    def get_all_vendors(destinyMembershipId, membershipType, characterId, component)
+      data = self.class.get(
+        "/Destiny2/#{membershipType}/Profile/#{destinyMembershipId}/"\
+        "Character/#{characterId}/Vendors?components=#{component}",
+        headers: @headers
+      )
+    end
+
+    # this will return the inventory of a single vendor that is supplied through the vendorHash param
+    # requires a components query string
+    # https://bungie-net.github.io/multi/schema_Destiny-DestinyComponentType.html#schema_Destiny-DestinyComponentType
+
+    def get_one_vendor(destinyMembershipId, membershipType, characterId, vendorHash)
+      data = self.class.get(
+        "/Destiny2/#{membershipType}/Profile/#{destinyMembershipId}/"\
+        "Character/#{characterId}/Vendors/#{vendorHash}?components=#{component}",
+        header: @headers
+      )
+    end
+
+  end
+end

data/lib/little_light/version.rb

@@ -0,0 +1,3 @@
+module LittleLight
+  VERSION = "0.1.0"
+end

data/little_light.gemspec

@@ -0,0 +1,28 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "little_light/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "little_light"
+  spec.version       = LittleLight::VERSION
+  spec.authors       = ["Brendan"]
+  spec.email         = ["brendanekane@gmail.com"]
+
+  spec.summary       = "Ruby wrapper for Destiny 2 API"
+  spec.homepage      = "https://github.com/brendanekane/little_light"
+  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_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: little_light
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Brendan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-07-23 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+description: 
+email:
+- brendanekane@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/little_light.rb
+- lib/little_light/clan.rb
+- lib/little_light/client.rb
+- lib/little_light/user.rb
+- lib/little_light/vendor.rb
+- lib/little_light/version.rb
+- little_light.gemspec
+homepage: https://github.com/brendanekane/little_light
+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: Ruby wrapper for Destiny 2 API
+test_files: []