karatekit 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5dd7b6325d8c8b310f1e7bc17c8cf5d570e9db7d
+  data.tar.gz: 964079363f1ac6b19f648f03f0a8cd1100a4ec83
+SHA512:
+  metadata.gz: 61162f1b560a580ba28239775d5d5b501e0be4d23bf8a74c41dbf38fee168e5cd1d32d6c9bc4fa9e90d407a6a45408b0e52a2a271edcd3866da14b3fb6eb7441
+  data.tar.gz: 2051a638c8399e49fe22f0194e06bc0e1a31faba5fe3ccd0104822480708ee016ee80f14c56a62e1bcaf086535a677f8037b441dc3c1187eff98aec5b3cedb4c

data/.gitignore

@@ -0,0 +1,8 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,7 @@
+---
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.5.3
+before_install: gem install bundler -v 1.16.6

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 pulleasy@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 karatekit.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,38 @@
+PATH
+  remote: .
+  specs:
+    karatekit (0.1.0)
+      sawyer (~> 0.8.0, >= 0.5.3)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.5.2)
+      public_suffix (>= 2.0.2, < 4.0)
+    coderay (1.1.2)
+    faraday (0.15.4)
+      multipart-post (>= 1.2, < 3)
+    method_source (0.9.2)
+    minitest (5.11.3)
+    multipart-post (2.0.0)
+    pry (0.12.2)
+      coderay (~> 1.1.0)
+      method_source (~> 0.9.0)
+    public_suffix (3.0.3)
+    rake (10.5.0)
+    sawyer (0.8.1)
+      addressable (>= 2.3.5, < 2.6)
+      faraday (~> 0.8, < 1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  karatekit!
+  minitest (~> 5.0)
+  pry (~> 0.12)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/MIT-LICENSE.md

@@ -0,0 +1,20 @@
+Copyright (c) 2019 Codegestalt GmbH
+
+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,7 @@
+# Karatekit
+
+Ruby toolkit for the kampfsport.center API.
+
+## Philosophy
+
+This Gem is based on GitHub's [Octokit.rb](https://github.com/octokit/octokit.rb).

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "karatekit"
+
+# 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/karatekit.gemspec

@@ -0,0 +1,31 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "karatekit/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "karatekit"
+  spec.version       = Karatekit::VERSION
+  spec.authors       = ["Daniel Puglisi"]
+  spec.email         = ["daniel@codegestalt.com"]
+
+  spec.summary       = %q{Ruby toolkit for the kampfsport.center API}
+  spec.description   = %q{Ruby toolkit for the kampfsport.center API}
+  spec.homepage      = "https://kampfsport.center"
+
+  # 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"]
+
+  spec.add_dependency 'sawyer', '>= 0.5.3', '~> 0.8.0'
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "pry", "~> 0.12"
+end

data/lib/karatekit/arguments.rb

@@ -0,0 +1,14 @@
+module Karatekit
+
+  # Extracts options from method arguments
+  # @private
+  class Arguments < Array
+    attr_reader :options
+
+    def initialize(args)
+      @options = args.last.is_a?(::Hash) ? args.pop : {}
+      super(args)
+    end
+
+  end
+end

data/lib/karatekit/authentication.rb

@@ -0,0 +1,15 @@
+module Karatekit
+
+  # Authentication methods for {Karatekit::Client}
+  module Authentication
+
+    # Indicates if the client was supplied an OAuth
+    # access token
+    #
+    # @see https://developer.github.com/v3/#authentication
+    # @return [Boolean]
+    def token_authenticated?
+      !!@access_token
+    end
+  end
+end

data/lib/karatekit/client/event_details.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the EventDetails API
+    #
+    # @see https://...
+    module EventDetails
+
+      # List event_details
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing event_details
+      # @see https://...
+      def event_details(options = {})
+        paginate "event_details", options
+      end
+
+      # Get a single event_detail
+      #
+      # @param id [Integer] ID of the event_detail
+      # @return [Sawyer::Resource] A single event_detail
+      # @see https://...
+      def event_detail(id, options = {})
+        get "event_details/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/event_parts.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the EventParts API
+    #
+    # @see https://...
+    module EventParts
+
+      # List event_parts
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing event_parts
+      # @see https://...
+      def event_parts(options = {})
+        paginate "event_parts", options
+      end
+
+      # Get a single event_part
+      #
+      # @param id [Integer] ID of the event_part
+      # @return [Sawyer::Resource] A single event_part
+      # @see https://...
+      def event_part(id, options = {})
+        get "event_parts/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/events.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the Events API
+    #
+    # @see https://...
+    module Events
+
+      # List events
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing events
+      # @see https://...
+      def events(options = {})
+        paginate "events", options
+      end
+
+      # Get a single event
+      #
+      # @param id [Integer] ID of the event
+      # @return [Sawyer::Resource] A single event
+      # @see https://...
+      def event(id, options = {})
+        get "events/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/instructor_details.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the InstructorDetails API
+    #
+    # @see https://...
+    module InstructorDetails
+
+      # List instructor_details
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing instructor_details
+      # @see https://...
+      def instructor_details(options = {})
+        paginate "instructor_details", options
+      end
+
+      # Get a single instructor_detail
+      #
+      # @param id [Integer] ID of the instructor_detail
+      # @return [Sawyer::Resource] A single instructor_detail
+      # @see https://...
+      def instructor_detail(id, options = {})
+        get "instructor_details/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/instructor_group_members.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the InstructorGroupMembers API
+    #
+    # @see https://...
+    module InstructorGroupMembers
+
+      # List instructor_group_members
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing instructor_group_members
+      # @see https://...
+      def instructor_group_members(options = {})
+        paginate "instructor_group_members", options
+      end
+
+      # Get a single instructor_group_member
+      #
+      # @param id [Integer] ID of the instructor_group_member
+      # @return [Sawyer::Resource] A single instructor_group_member
+      # @see https://...
+      def instructor_group_member(id, options = {})
+        get "instructor_group_members/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/instructor_groups.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the InstructorGroups API
+    #
+    # @see https://...
+    module InstructorGroups
+
+      # List instructor_groups
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing instructor_groups
+      # @see https://...
+      def instructor_groups(options = {})
+        paginate "instructor_groups", options
+      end
+
+      # Get a single instructor_group
+      #
+      # @param id [Integer] ID of the instructor_group
+      # @return [Sawyer::Resource] A single instructor_group
+      # @see https://...
+      def instructor_group(id, options = {})
+        get "instructor_groups/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/instructors.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the Instructors API
+    #
+    # @see https://...
+    module Instructors
+
+      # List instructors
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing instructors
+      # @see https://...
+      def instructors(options = {})
+        paginate "instructors", options
+      end
+
+      # Get a single instructor
+      #
+      # @param id [Integer] ID of the instructor
+      # @return [Sawyer::Resource] A single instructor
+      # @see https://...
+      def instructor(id, options = {})
+        get "instructors/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/locations.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the Locations API
+    #
+    # @see https://...
+    module Locations
+
+      # List locations
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing locations
+      # @see https://...
+      def locations(options = {})
+        paginate "locations", options
+      end
+
+      # Get a single location
+      #
+      # @param id [Integer] ID of the location
+      # @return [Sawyer::Resource] A single location
+      # @see https://...
+      def location(id, options = {})
+        get "locations/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/posts.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the Posts API
+    #
+    # @see https://...
+    module Posts
+
+      # List posts
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing posts
+      # @see https://...
+      def posts(options = {})
+        paginate "posts", options
+      end
+
+      # Get a single post
+      #
+      # @param id [Integer] ID of the post
+      # @return [Sawyer::Resource] A single post
+      # @see https://...
+      def post(id, options = {})
+        get "posts/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/products.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the Products API
+    #
+    # @see https://...
+    module Products
+
+      # List products
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing products
+      # @see https://...
+      def products(options = {})
+        paginate "products", options
+      end
+
+      # Get a single product
+      #
+      # @param id [Integer] ID of the product
+      # @return [Sawyer::Resource] A single product
+      # @see https://...
+      def product(id, options = {})
+        get "products/#{id}", options
+      end
+    end
+  end
+end

data/lib/karatekit/client/rate_limit.rb

@@ -0,0 +1,53 @@
+module Karatekit
+  class Client
+
+    # Methods for API rate limiting info
+    #
+    # @see https://developer.github.com/v3/#rate-limiting
+    module RateLimit
+
+      # Get rate limit info from last response if available
+      # or make a new request to fetch rate limit
+      #
+      # @see https://developer.github.com/v3/rate_limit/#rate-limit
+      # @return [Karatekit::RateLimit] Rate limit info
+      def rate_limit(options = {})
+        return rate_limit! if last_response.nil?
+
+        Karatekit::RateLimit.from_response(last_response)
+      end
+      alias ratelimit rate_limit
+
+      # Get number of rate limted requests remaining
+      #
+      # @see https://developer.github.com/v3/rate_limit/#rate-limit
+      # @return [Integer] Number of requests remaining in this period
+      def rate_limit_remaining(options = {})
+        octokit_warn "Deprecated: Please use .rate_limit.remaining"
+        rate_limit.remaining
+      end
+      alias ratelimit_remaining rate_limit_remaining
+
+      # Refresh rate limit info by making a new request
+      #
+      # @see https://developer.github.com/v3/rate_limit/#rate-limit
+      # @return [Karatekit::RateLimit] Rate limit info
+      def rate_limit!(options = {})
+        get "rate_limit"
+        Karatekit::RateLimit.from_response(last_response)
+      end
+      alias ratelimit! rate_limit!
+
+      # Refresh rate limit info and get number of rate limted requests remaining
+      #
+      # @see https://developer.github.com/v3/rate_limit/#rate-limit
+      # @return [Integer] Number of requests remaining in this period
+      def rate_limit_remaining!(options = {})
+        octokit_warn "Deprecated: Please use .rate_limit!.remaining"
+        rate_limit!.remaining
+      end
+      alias ratelimit_remaining! rate_limit_remaining!
+
+    end
+  end
+end

data/lib/karatekit/client/sessions.rb

@@ -0,0 +1,27 @@
+module Karatekit
+  class Client
+
+    # Methods for the Sessions API
+    #
+    # @see https://...
+    module Sessions
+
+      # List sessions
+      #
+      # @return [Array<Sawyer::Resource>] An array of hashes representing sessions
+      # @see https://...
+      def sessions(options = {})
+        paginate "sessions", options
+      end
+
+      # Get a single session
+      #
+      # @param id [Integer] ID of the session
+      # @return [Sawyer::Resource] A single session
+      # @see https://...
+      def session(id, options = {})
+        get "sessions/#{id}", options
+      end
+    end
+  end
+end