bloc-atlas 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: a90e96e0da93a2ea8c16b41af09f71696efc0eef
+  data.tar.gz: 537bb1d948c99d854d9f16be45edfe919a1d91ba
+SHA512:
+  metadata.gz: c072e895ebea7e8f4243190a19a8eb6a3977597c2f55583a0dbf178557665e79a2e19ba31352c99f6fb635849d346c5bf6e47e834570de9bf511dc7cd48ca73f
+  data.tar.gz: 74f96246ea2aed949e072fb5aaf51e71354cc04558ebb6878ba7d4076a8efc279be4d610150020aa69c6d332ccc4a5008c49ab4a11b7a59c8e5f2c3a7632d0ab

data/.gitignore

@@ -0,0 +1,50 @@
+*.rbc
+capybara-*.html
+.rspec
+/log
+/tmp
+/db/*.sqlite3
+/db/*.sqlite3-journal
+/public/system
+/coverage/
+/spec/tmp
+**.orig
+rerun.txt
+pickle-email-*.html
+
+# TODO Comment out these rules if you are OK with secrets being uploaded to the repo
+config/initializers/secret_token.rb
+config/secrets.yml
+
+## Environment normalization:
+/.bundle
+/vendor/bundle
+
+# these should all be checked in to normalize the environment:
+# Gemfile.lock, .ruby-version, .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+# if using bower-rails ignore default bower_components path bower.json files
+/vendor/assets/bower_components
+*.bowerrc
+bower.json
+
+# Ignore pow environment settings
+.powenv
+
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+
+# Ignore application configuration
+/config/application.yml
+atlas-*

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.11.2

data/Gemfile

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

data/README.md

@@ -0,0 +1,37 @@
+#Atlas
+
+Ruby toolkit for the Workshop API.
+
+![Atlas](http://bloc-global-assets.s3.amazonaws.com/atlas.jpg)
+
+##Quick start
+
+Install via Rubygems
+
+```bash
+gem install atlas
+```
+
+... or add to your Gemfile
+
+```ruby
+gem "atlas", "~> 0.1.0"
+```
+
+## Usage
+
+Create a new `Atlas` client using your Bloc username and password:
+
+```ruby
+atlas = Atlas.new("api_key")
+```
+
+Then use the client to make requests:
+
+```ruby
+atlas.update_exercise(129, {name: "New Exercise Name"})
+```
+
+## Acknowledgements
+
+This gem is inspired by [octokit](https://github.com/octokit)

data/Rakefile

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

data/atlas.gemspec

@@ -0,0 +1,37 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+Gem::Specification.new do |spec|
+  spec.name          = "bloc-atlas"
+  spec.version       = '0.1.1'
+  spec.authors       = ["Rob Madden"]
+  spec.email         = ["rob.madden@bloc.io"]
+
+  spec.summary       = %q{A Ruby API client for Workshop.}
+  spec.description   = %q{A Ruby API client for Workshop.}
+  spec.homepage      = "http://rubygems.org/gems/bloc-atlas"
+  spec.license       = 'MIT'
+
+  # Prevent pushing this gem to RubyGems.org by setting 'allowed_push_host', or
+  # delete this section to allow pushing this gem 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 { |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_development_dependency "bundler", "~> 1.11"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_runtime_dependency 'httparty', '~>0.13.7'
+  spec.add_runtime_dependency 'activesupport', '~>4.2'
+  spec.add_runtime_dependency 'json', '~>1.8'
+  spec.add_development_dependency 'vcr', '~>2.9'
+  spec.add_development_dependency 'webmock', '~>1.22'
+end

data/lib/atlas.rb

@@ -0,0 +1,16 @@
+require 'httparty'
+require 'json'
+
+require_relative 'client/exercises'
+
+Dir[File.dirname(__FILE__) + '/client/*.rb'].each {|file| require file }
+
+class Atlas
+  include HTTParty
+  include Exercises
+
+  def initialize(api_key, api_base_path="localhost:3000/api/v1")
+    @api_base_path = api_base_path
+    @api_key =  api_key
+  end
+end

data/lib/client/base_client.rb

@@ -0,0 +1,47 @@
+require_relative 'class_factory'
+
+module BaseClient
+  # Handle API timeouts
+  def handle_timeouts
+    begin
+      yield
+    rescue Net::OpenTimeout, Net::ReadTimeout
+      {}
+    end
+  end
+
+  # This needs a better name
+  def convert_response(response, name)
+    if success?(response.code)
+      body = response.body.is_a?(String) ? JSON.parse(response.body) : response.body
+
+      if body.is_a?(Array)
+        body.map {|hash| ClassFactory.build_response_object(hash, name)}
+      else
+        ClassFactory.build_response_object(body, name)
+      end
+    else
+      return response
+    end
+  end
+
+  def success?(code)
+    code.between?(200, 299)
+  end
+
+  # Set the API Authorization Header
+  #
+  # @return [Hash] The authorization header
+  def auth_header
+    { "authorization" => 'Token token=' + @api_key }
+  end
+
+  def convert_keys(options)
+    options.keys.each {|k| options[k.to_s] = options.delete(k) if k.kind_of?(Symbol)}
+    options
+  end
+
+  def whitelist_params(options, whitelist)
+    options.select {|k, v| whitelist.include?(k)}
+  end
+end

data/lib/client/class_factory.rb

@@ -0,0 +1,30 @@
+require 'json'
+require 'active_support/inflector'
+
+module ClassFactory
+  def ClassFactory.build_response_object(response_hash, name)
+    if Object.const_defined?(name.camelize)
+      name.camelize.constantize.new(response_hash)
+    else
+      generic_class = ClassFactory::GenericClass.new
+      generic_class.create_class name
+      name.camelize.constantize.new(response_hash)
+    end
+  end
+
+  class GenericClass
+    def create_class name
+      Object.const_set(name.classify,
+                       Class.new do
+                         def initialize(hash)
+                           hash.each do |k,v|
+                             self.instance_variable_set("@#{k}", v)
+                             self.class.send(:define_method, k, proc{self.instance_variable_get("@#{k}")})
+                             self.class.send(:define_method, "#{k}=", proc{|v| self.instance_variable_set("@#{k}", v)})
+                           end
+                         end
+                       end
+      )
+    end
+  end
+end

data/lib/client/exercises.rb

@@ -0,0 +1,62 @@
+require_relative 'base_client'
+
+module Exercises
+  include BaseClient
+
+  # Get all exercises
+  #
+  # @return [HTTParty::Response] All exercises.
+  # @example Get all exercises
+  #   Atlas#get_exercises
+  def get_exercises
+    url = "#{@api_base_path}/exercises"
+    handle_timeouts do
+      response = self.class.get(url, headers: auth_header)
+      convert_response(response, "exercises")
+    end
+  end
+
+  # Get an exercise
+  #
+  # @return [HTTParty::Response] One exercise.
+  # @example Get exercise by id
+  #   Atlas#get_exercise(id)
+  def get_exercise(id)
+    url = "#{@api_base_path}/exercises/" + id.to_s
+    handle_timeouts do
+      response = self.class.get(url, headers: auth_header)
+      convert_response(response, "exercise")
+    end
+  end
+
+  # Update an exercise
+  #
+  # @param id [Integer] An exercise id.
+  # @param options [Hash] A customizable set of options.
+  # @option options [String] :name Exercise name.
+  # @option options [String] :body Exercise body.
+  # @option options [Integer] :status Exercise status.
+  # @option options [String] :slug Exercise slug.
+  # @option options [String] :specs Exercise specs.
+  # @option options [String] :starting_code Exercise starting code.
+  # @option options [String] :canonical_solution Exercise solution.
+  # @option options [String] :language Exercise language.
+  # @return [Exercise] The updated checkpoint
+  # @example Update a checkpoint
+  #   Atlas#update_checkpoint(1, {name: 'Real Cool Exercise'})
+  def update_exercise(id, options={})
+    whitelist = ['name', 'body', 'status', 'slug','specs', 'starting_code', 'canonical_solution', 'language']
+
+    options = convert_keys(options)
+    params = whitelist_params(options, whitelist)
+    url = "#{@api_base_path}/exercises/#{id}"
+
+    handle_timeouts do
+      response = self.class.put(url,
+                                headers: auth_header,
+                                body: { exercise: params })
+      convert_response(response, "exercise")
+    end
+  end
+
+end

metadata

@@ -0,0 +1,169 @@
+--- !ruby/object:Gem::Specification
+name: bloc-atlas
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Rob Madden
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-05-25 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.11'
+- !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: httparty
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.7
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.2'
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.9'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.22'
+description: A Ruby API client for Workshop.
+email:
+- rob.madden@bloc.io
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- README.md
+- Rakefile
+- atlas.gemspec
+- config/application.yml
+- lib/atlas.rb
+- lib/client/base_client.rb
+- lib/client/class_factory.rb
+- lib/client/exercises.rb
+homepage: http://rubygems.org/gems/bloc-atlas
+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.5.1
+signing_key: 
+specification_version: 4
+summary: A Ruby API client for Workshop.
+test_files: []