ruby_ufc 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 87bdfb49c6c05ca46969b823e5273971d1be4afd
+  data.tar.gz: ad7c6ca48f49d2c1648129c0ab163e47d1f2711c
+SHA512:
+  metadata.gz: f2dcd60332cf5d9acec4a8b3a2c190eaed5a9b61bdedd116eb66022ff3500f823637f5d28b95e6f483593fe8475a8513f8d0b769a92be5f304c09e2c0c462545
+  data.tar.gz: a9e4ebc2272801552da06f202109ce14883ebdb3ebd348b9ed9f8f918e28569b8bb456bd0eb2b9416614b83321d5b7a66c6dc24a71c441daf76fa877de7a89d2

data/.gitignore

@@ -0,0 +1,10 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.ruby-version

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.4.1
+before_install: gem install bundler -v 1.15.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 ruby_ufc.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Kiriakos Velissariou
+
+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,68 @@
+# ruby_ufc
+
+:warning: :construction: **Under heavy development** :warning: :construction:
+
+[![Build Status](https://travis-ci.org/kiriakosv/ruby_ufc.svg?branch=master)](https://travis-ci.org/kiriakosv/ruby_ufc)
+[![Coverage Status](https://coveralls.io/repos/github/kiriakosv/ruby_ufc/badge.svg?branch=master)](https://coveralls.io/github/kiriakosv/ruby_ufc?branch=master)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2c5d82e2464d857bd494/maintainability)](https://codeclimate.com/github/kiriakosv/ruby_ufc/maintainability)
+
+A simple Ruby wrapper to communicate with the UFC API.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_ufc'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install ruby_ufc
+
+## Usage
+
+Description and examples of the supported actions are below. Every action returns an Array of Hashes or an empty Array.
+
+```ruby
+# Instantantiate
+client = RubyUfc::Client.new
+
+client.fighters # Returns an Array of Hashes with all the fighters
+
+client.fighters(first_name: 'Conor') # Returns each fighter whose first name is Conor
+
+client.fighters(first_name: 'SomeWeirdName') # Returns an empty Array
+
+client.fighters(unknown_key: 'A value') # Returns an empty Array
+```
+
+Every supported action has the same behaviour as the action above. Currently
+supported actions are:
+* fighters
+* octagon_girls
+* events
+* news
+* media
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` 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
+
+In order to contribute to this project, follow the guidelines below:
+* Fork the project
+* Create a feature branch and pull request.
+* Make your commits atomic and descriptive. You can find a nice guide for Git
+  best practices [here](https://github.com/agis/git-style-guide) .
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

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 "ruby_ufc"
+
+# 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/config/config.yml

@@ -0,0 +1,2 @@
+base_end_point: 'http://ufc-data-api.ufc.com/api'
+version: 'v3'

data/lib/ruby_ufc.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+require 'net/http'
+require 'json'
+require 'yaml'
+
+require 'ruby_ufc/version'
+require 'ruby_ufc/client'

data/lib/ruby_ufc/client.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module RubyUfc
+  # :nodoc:
+  class Client
+    ALLOWED_RESOURCES = %w[fighters octagon_girls events news media].freeze
+
+    attr_reader :base_end_point, :version
+
+    def initialize
+      config_params = YAML.load_file('lib/config/config.yml')
+      @base_end_point = config_params['base_end_point']
+      @version = config_params['version']
+    end
+
+    ALLOWED_RESOURCES.each do |allowed_resource|
+      define_method(allowed_resource) do |args = {}|
+        url = construct_url(allowed_resource)
+        response = get_json_response(url)
+        response if args.empty?
+        filter_by_argument(response, args)
+      end
+    end
+
+    private
+
+    def construct_url(name)
+      "#{@base_end_point}/#{@version}/#{name}.json"
+    end
+
+    def get_json_response(url)
+      uri = URI(url)
+      response = Net::HTTP.get(uri)
+      JSON.parse(response)
+    end
+
+    def filter_by_argument(response, args)
+      key = args.keys.first
+      value = args[key]
+      response.select { |ans| ans[key.to_s] == value }
+    end
+  end
+end

data/lib/ruby_ufc/version.rb

@@ -0,0 +1,3 @@
+module RubyUfc
+  VERSION = "0.2.0"
+end

data/ruby_ufc.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "ruby_ufc/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_ufc"
+  spec.version       = RubyUfc::VERSION
+  spec.authors       = ["Kiriakos Velissariou"]
+  spec.email         = ["kir.velissariou@gmail.com"]
+
+  spec.summary       = %q{A simple Ruby wrapper to communicate with the UFC API.}
+  spec.homepage      = "https://github.com/kiriakosv/ruby_ufc"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  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.15"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "coveralls", "~> 0.8"
+end

metadata

@@ -0,0 +1,114 @@
+--- !ruby/object:Gem::Specification
+name: ruby_ufc
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Kiriakos Velissariou
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.15'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.8'
+description: 
+email:
+- kir.velissariou@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/config/config.yml
+- lib/ruby_ufc.rb
+- lib/ruby_ufc/client.rb
+- lib/ruby_ufc/version.rb
+- ruby_ufc.gemspec
+homepage: https://github.com/kiriakosv/ruby_ufc
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+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.6.11
+signing_key: 
+specification_version: 4
+summary: A simple Ruby wrapper to communicate with the UFC API.
+test_files: []