challonge_user_rails 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 795487f9f9e2ad543bfaa81e453dc83b1c0208361ef06d9d08fb047f4bf3fd79
+  data.tar.gz: e323d78c7aa5bea8a576867c26987d77ab9658243c6bf5df5e4b21c5662581c7
+SHA512:
+  metadata.gz: 97972075c937dbf110455613781162bd8a5dc0cfea4f486f8b7dd3c4258c1fd40816df630f33bfe2d4bb8f61e8d7d0fac20f4d28e7510d9bb9d06cda6e1bf0a4
+  data.tar.gz: 4e9eed41750cfca6638fc4e081cb8a4a56547ba07fafbc065268799cd0a71f889bd57342ee0c9b6ca6f28f45a26f97f6d46a893f7d7f4bb4a379a01a692e6377

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.travis.yml

@@ -0,0 +1,6 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.7.3
+before_install: gem install bundler -v 2.1.4

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 TODO: Write your email address. 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 [https://contributor-covenant.org/version/1/4][version]
+
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,7 @@
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in challonge_user_rails.gemspec
+gemspec
+
+gem "rake", "~> 12.0"
+gem "rspec", "~> 3.0"

data/Gemfile.lock

@@ -0,0 +1,59 @@
+PATH
+  remote: .
+  specs:
+    challonge_user_rails (0.1.0)
+      faraday (~> 1.7)
+      faraday_middleware (~> 1.1)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    diff-lcs (1.4.4)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
+      multipart-post (>= 1.2, < 3)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    faraday_middleware (1.1.0)
+      faraday (~> 1.0)
+    multipart-post (2.1.1)
+    rake (12.3.3)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  challonge_user_rails!
+  rake (~> 12.0)
+  rspec (~> 3.0)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 TODO: Write your name
+
+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,79 @@
+# Challonge API for user
+
+This gem is for educational use only. I have created this to have a practice on how to create an API wrapper for Rails and create it in a ruby gem.
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'challonge_user_rails'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install challonge_user_rails
+
+## Usage
+
+### Get an API Token from Challonge site
+Create an account on [Challonge Website](https://challonge.com) and get an API via Settings - Developer API.
+
+### Configure
+It is suggested to create an instance of the client.
+
+```ruby
+client = ChallongeUserRails::Client.new(api_key: [YOUR API KEY])
+```
+
+### Get all Tournaments
+
+```ruby
+client.tournaments
+```
+
+### Get specific Tournament
+Tournament URL is the URL parameter (not the address) of the tournament when you create it.
+
+```ruby
+client.tournament(tournament_url)
+```
+
+### Delete Tournament
+```ruby
+client.delete_tournament(tournament_url)
+```
+
+### Create Tournament
+Challonge API expects a json data with attributes related to creation of a tournament. You may refer to their [docs](https://api.challonge.com/v2/api_docs/single_swagger_doc#!/Tournament/createTournament) for an example json value.
+```ruby
+client.create_tournament(data)
+```
+
+### Get All Matches
+```ruby
+client.matches
+```
+
+### Get Tournament Matches
+```ruby
+client.match(tournament_url, match_id)
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/michael-dollosa/challonge_user_rails. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/michael-dollosa/challonge_user_rails/blob/master/CODE_OF_CONDUCT.md).
+
+
+## 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 ChallongeUserRails project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/michael-dollosa/challonge_user_rails/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,16 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "challonge_user_rails"
+
+# 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
+
+client = ChallongeUserRails::Client.new(api_key: "Bu1jqfn2whgYiS2uOeD4iiTf25P2amiyuxLhHMKZ")
+
+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/challonge_user_rails.gemspec

@@ -0,0 +1,33 @@
+require_relative 'lib/challonge_user_rails/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "challonge_user_rails"
+  spec.version       = ChallongeUserRails::VERSION
+  spec.authors       = ["Christian Michael Dollosa"]
+  spec.email         = ["dollosa.christian@gmail.com"]
+
+  spec.summary       = %q{This is a simple API wrapper for Challong API users.}
+  spec.description   = %q{Used for Avion Project using api wrappers.}
+  spec.homepage      = "https://github.com/michael-dollosa/challonge-user-rails"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
+
+  # spec.metadata["allowed_push_host"] = "http://mygemserver.com"
+
+  # spec.metadata["homepage_uri"] = spec.homepage
+  # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
+  # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |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"]
+
+  #add dependency
+  spec.add_dependency "faraday", "~> 1.7"
+  spec.add_dependency "faraday_middleware", "~> 1.1"
+end

data/lib/challonge_user_rails/client.rb

@@ -0,0 +1,64 @@
+require "faraday"
+require "faraday_middleware"
+
+module ChallongeUserRails
+  class Client
+    BASE_URL = "https://api.challonge.com/v2/"
+    attr_reader :api_key, :adapter
+
+    def initialize(api_key:, adapter: Faraday.default_adapter )
+      @api_key = api_key
+      @adapter = adapter
+    end
+
+    def connection
+      @connection ||= Faraday.new do |conn|
+        conn.url_prefix = BASE_URL
+        conn.request :json
+        conn.response :json, content_type: "application/json"
+        conn.adapter adapter
+        conn.headers['Content-Type'] = 'application/vnd.api+json'
+        conn.headers['Accept'] = 'application/json'
+        conn.headers['Authorization-Type'] = 'v1'
+        conn.headers['Authorization'] = @api_key
+      end
+    end
+
+    #endpoints
+
+    #get all tournaments from user account
+    def tournaments
+      res = connection.get("tournaments.json").body
+    end
+
+    #get specific tournament via slug/url
+    def tournament(slug)
+      connection.get("tournaments/#{slug}.json").body
+    end
+
+    #get all matches of specific tournament
+    def matches(slug)
+      connection.get("tournaments/#{slug}/matches.json").body
+    end
+
+    #get specific match
+    def match(slug, id)
+      connection.get("tournaments/#{slug}/matches/#{id}.json").body
+    end
+
+    #create tournament
+    def create_tournament(data)
+      connection.post("tournaments.json", data).body
+    end
+
+    #delete tournament
+    def delete_tournament(slug)
+      connection.delete("tournaments/#{slug}.json").body
+    end
+
+    #change once deployed
+    def inspect
+      "#<ChallongUserAPI::Client>"
+    end
+  end
+end

data/lib/challonge_user_rails/error.rb

@@ -0,0 +1,5 @@
+module ChallongeUserRails
+  class Error
+    
+  end
+end

data/lib/challonge_user_rails/version.rb

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

data/lib/challonge_user_rails.rb

@@ -0,0 +1,6 @@
+require "challonge_user_rails/version"
+
+module ChallongeUserRails
+  autoload :Client, "challonge_user_rails/client"
+  autoload :Error, "challonge_user_rails/error"
+end

metadata

@@ -0,0 +1,87 @@
+--- !ruby/object:Gem::Specification
+name: challonge_user_rails
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Christian Michael Dollosa
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.1'
+description: Used for Avion Project using api wrappers.
+email:
+- dollosa.christian@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- challonge_user_rails.gemspec
+- lib/challonge_user_rails.rb
+- lib/challonge_user_rails/client.rb
+- lib/challonge_user_rails/error.rb
+- lib/challonge_user_rails/version.rb
+homepage: https://github.com/michael-dollosa/challonge-user-rails
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.3.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.6
+signing_key:
+specification_version: 4
+summary: This is a simple API wrapper for Challong API users.
+test_files: []