cwsrb 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3a9819ae04560d78506287cd52a93a95c4309a20
+  data.tar.gz: fceb3bbf0edcf501d2ccff0540c962895d86d411
+SHA512:
+  metadata.gz: 0f91cbacc3f81efa121e75ea643edd591fdd339ba73720ec8664d07384134c94cc00f9e9155ff944682b5ad1d13a5c7e62583518bac1fd20d8526b2281abb1ac
+  data.tar.gz: 852b4c8b3b989a134e55b97ab31f962135afcfa9ceb7cc7bc5aa3ab2cea816ec067a2763e0a594470caad5e550d27d7c37e9273323a2ebb7b5ba6e31e60d96b1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.rubocop.yml

@@ -0,0 +1,11 @@
+Metrics/LineLength:
+  Max: 120
+
+# TODO: documentation (I SWEAR I'LL DO IT SOMEDAY)
+Style/Documentation:
+  Exclude:
+    - 'spec/**/*'
+    - 'test/**/*'
+    - 'lib/cwsrb.rb'
+    - 'lib/cwsrb/api.rb'
+    - 'lib/cwsrb/helpers.rb'

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in cwsrb.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Unleashy
+
+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,29 @@
+# Cwsrb
+
+Cwsrb is a simple API wrapper for [ConWorkShop](http://conworkshop.com).
+
+## Dependencies
+
+* Ruby 2.1+
+
+## Installation
+
+Check the [Development section](https://github.com/unleashy/cwsrb#development). I'll probably put this in [rubygems.org](https://rubygems.org) later.
+
+## Usage
+
+... TODO ...
+
+## 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/unleashy/cwsrb. Don't forget to use rubocop!
+
+## 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,6 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task default: :spec

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'cwsrb'
+
+require 'irb'
+IRB.start

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/bin/setup.bat

@@ -0,0 +1 @@
+bundle install

data/cwsrb.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'cwsrb/version'
+
+Gem::Specification.new do |spec|
+  spec.name    = 'cwsrb'
+  spec.version = Cwsrb::VERSION
+  spec.authors = ['Unleashy']
+  spec.email   = ['']
+
+  spec.summary     = "Access Conworkshop's API with Ruby."
+  spec.description = "A simple wrapper for ConWorkShop's (http://conworkshop.com) API in Ruby."
+  spec.homepage    = 'https://github.com/unleashy/cwsrb'
+  spec.license     = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'httparty'
+
+  spec.required_ruby_version = '>= 2.1.0'
+
+  spec.add_development_dependency 'bundler', '~> 1.12'
+  spec.add_development_dependency 'rake',    '~> 10.0'
+  spec.add_development_dependency 'rspec',   '~> 3.0'
+  spec.add_development_dependency 'rubocop', '~> 0.40.0'
+end

data/lib/cwsrb.rb

@@ -0,0 +1,7 @@
+require 'cwsrb/version'
+require 'cwsrb/errors'
+require 'cwsrb/helpers'
+require 'cwsrb/api'
+
+module Cwsrb
+end

data/lib/cwsrb/api.rb

@@ -0,0 +1,36 @@
+require 'httparty'
+require 'cwsrb/errors'
+require 'cwsrb/helpers'
+
+module Cwsrb
+  class API
+    include HTTParty
+    base_uri 'http://conworkshop.com'
+
+    def initialize(user_agent)
+      self.class.headers 'User-Agent' =>
+                             "#{user_agent} CWSrb/#{Cwsrb::VERSION} (#{RUBY_ENGINE}/#{RUBY_VERSION}p#{RUBY_PATCHLEVEL})"
+    end
+
+    def get_karma(val)
+      # Determine if val is an ID or username.
+      usr = Cwsrb::Helpers.resolve(val)
+      response = self.class.get("/api?f=USER_KARMA&USER=#{usr}")
+
+      # Check if any errors occurred
+      Cwsrb::Helpers.check_for_errors(response)
+
+      response['out']
+    end
+
+    def get_user(val)
+      usr = Cwsrb::Helpers.resolve(val)
+      response = self.class.get("/api?f=USER&USER=#{usr}")
+
+      # Check if any errors occurred
+      Cwsrb::Helpers.check_for_errors(response)
+
+      response['out']
+    end
+  end
+end

data/lib/cwsrb/errors.rb

@@ -0,0 +1,4 @@
+module Cwsrb
+  Error = Class.new(RuntimeError)
+  APIError = Class.new(Error)
+end

data/lib/cwsrb/helpers.rb

@@ -0,0 +1,16 @@
+module Cwsrb
+  module Helpers
+    module_function
+
+    def resolve(val)
+      # Determine if val is an ID or username.
+      # ID is a bunch of numbers that can or cannot be followed by an 'S'.
+      # Username... is not an ID.
+      (val =~ /\A(S?\d+)\z/) ? val : "@#{val}"
+    end
+
+    def check_for_errors(response)
+      raise Cwsrb::APIError, response['err_msg'] if response['err_idx'] > 0
+    end
+  end
+end

data/lib/cwsrb/version.rb

@@ -0,0 +1,3 @@
+module Cwsrb
+  VERSION = '0.2.0'.freeze
+end

metadata

@@ -0,0 +1,131 @@
+--- !ruby/object:Gem::Specification
+name: cwsrb
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Unleashy
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-06-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.40.0
+description: A simple wrapper for ConWorkShop's (http://conworkshop.com) API in Ruby.
+email:
+- ''
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- bin/setup.bat
+- cwsrb.gemspec
+- lib/cwsrb.rb
+- lib/cwsrb/api.rb
+- lib/cwsrb/errors.rb
+- lib/cwsrb/helpers.rb
+- lib/cwsrb/version.rb
+homepage: https://github.com/unleashy/cwsrb
+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.1.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: Access Conworkshop's API with Ruby.
+test_files: []