rest-gw2 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: db66e083f2389a6f7e6607b09b3cebc8acf62037
+  data.tar.gz: 09e66dee7a294ef69d94fe9de9f273cb08aa59b0
+SHA512:
+  metadata.gz: 673e5d69c6e911e91da4f32c6625ab77791be6edaf9e56bd8e739a6f5cc25f73a4132cff3b0710ac5acb99202e42c16557a5009262f1fd2953b13f481f81e250
+  data.tar.gz: e13ea78cd360116df6308f6a776a0e1505f51dda8c12d39b49889a24662c2d27cc92f928f8aaf961167d7f39635d35354deddd96c076a34240ee5370ef8311a1

data/.gitignore

@@ -0,0 +1,3 @@
+.env
+/pkg/
+/coverage/

data/.gitmodules

@@ -0,0 +1,3 @@
+[submodule "task"]
+	path = task
+	url = git://github.com/godfat/gemgem.git

data/README.md

@@ -0,0 +1,76 @@
+# rest-gw2 [![Build Status](https://secure.travis-ci.org/godfat/rest-gw2.png?branch=master)](http://travis-ci.org/godfat/rest-gw2) [![Coverage Status](https://coveralls.io/repos/godfat/rest-gw2/badge.png)](https://coveralls.io/r/godfat/rest-gw2) [![Join the chat at https://gitter.im/godfat/rest-gw2](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/godfat/rest-gw2)
+
+by Lin Jen-Shin ([godfat](http://godfat.org))
+
+## LINKS:
+
+* [github](https://github.com/godfat/rest-gw2)
+* [rubygems](https://rubygems.org/gems/rest-gw2)
+* [rdoc](http://rdoc.info/github/godfat/rest-gw2)
+
+## DESCRIPTION:
+
+A very simple [Guild Wars 2 API](https://wiki.guildwars2.com/wiki/API:Main)
+client built with [rest-core](https://github.com/godfat/rest-core).
+
+There's also a bundled web application showing your items, serving as an
+example using the client.
+
+## FEATURES:
+
+* Caching from rest-core for the win.
+* Concurrency from rest-core for the win.
+
+## REQUIREMENTS:
+
+* Tested with MRI (official CRuby), Rubinius and JRuby.
+* rest-core
+* jellyfish (only for web application)
+
+## INSTALLATION:
+
+    gem install rest-gw2
+
+## SYNOPSIS:
+
+``` ruby
+require 'rest-gw2'
+gw2 = RestGW2::Client.new(:access_token => '...')
+gw2.get('account/bank') # => list of items in your bank
+```
+
+## Bundled Web Application:
+
+If you would like to try it, run with:
+
+    env ACCESS_TOKEN=... rest-gw2-server
+
+Or you could put your access token in a config file and point it with:
+
+    env RESTGW2_CONFIG=... rest-gw2-server
+
+The format for the config file would be like:
+
+    ACCESS_TOKEN=...
+
+## CONTRIBUTORS:
+
+* Lin Jen-Shin (@godfat)
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2015, Lin Jen-Shin (godfat)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/Rakefile

@@ -0,0 +1,13 @@
+
+begin
+  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+rescue LoadError
+  sh 'git submodule update --init'
+  exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
+end
+
+Gemgem.init(dir) do |s|
+  s.name    = 'rest-gw2'
+  s.version = '0.1.0'
+  %w[rest-core].each{ |g| s.add_runtime_dependency(g) }
+end

data/config.ru

@@ -0,0 +1,3 @@
+
+require 'rest-gw2'
+run RestGW2::Server

data/lib/rest-gw2.rb

@@ -0,0 +1,5 @@
+
+module RestGW2
+  autoload :Client, 'rest-gw2/client'
+  autoload :Server, 'rest-gw2/server'
+end

data/lib/rest-gw2/client.rb

@@ -0,0 +1,32 @@
+
+require 'rest-core'
+
+module RestGW2
+  Client = RC::Builder.client do
+    use RC::DefaultSite   , 'https://api.guildwars2.com/v2/'
+    use RC::DefaultHeaders, {'Accept' => 'application/json'}
+    use RC::Oauth2Header  , 'Bearer', nil
+
+    use RC::Timeout       , 10
+    use RC::ErrorHandler  ,
+      lambda{ |env| RuntimeError.new(env[RC::RESPONSE_BODY]) }
+    use RC::ErrorDetectorHttp
+
+    use RC::JsonResponse  , true
+    use RC::CommonLogger  , nil
+    use RC::Cache         , nil, 600
+  end
+
+  Client.include(Module.new{
+    def with_item_detail path, query={}
+      items = get(path, query)
+      ids   = items.map{ |i| i && i['id'] }
+
+      detail = ids.compact.each_slice(5).map do |slice|
+        get('items', :ids => slice.join(','))
+      end.flatten.group_by{ |i| i['id'] }
+
+      items.map{ |i| i && detail[i['id']].first.merge('count' => i['count']) }
+    end
+  })
+end

data/lib/rest-gw2/server.rb

@@ -0,0 +1,89 @@
+
+require 'dalli'
+require 'jellyfish'
+
+require 'erb'
+
+module RestGW2
+  CONFIG = ENV['RESTGW2_CONFIG'] || File.expand_path("#{__dir__}/../../.env")
+
+  def self.extract_env path
+    return {} unless File.exist?(path)
+    Hash[File.read(path).strip.squeeze("\n").each_line.map do |line|
+      name, value = line.split('=')
+      [name, value.chomp] if name && value
+    end.compact]
+  end
+
+  extract_env(CONFIG).each do |k, v|
+    ENV[k] ||= v
+  end
+
+  module DalliExtension
+    def [] *args
+      get(*args)
+    end
+
+    def []= *args
+      set(*args)
+    end
+
+    def store *args
+      set(*args)
+    end
+  end
+
+  def self.cache
+    @cache ||= begin
+      client = Dalli::Client.new
+      client.extend(DalliExtension)
+      client
+    end
+  end
+
+  class ServerCore
+    include Jellyfish
+    controller_include Module.new{
+      def render path
+        ERB.new(views(path)).result(binding)
+      end
+
+      def views path
+        @views ||= {}
+        @views[path] ||= File.read("#{__dir__}/view/#{path}.erb")
+      end
+
+      def item_title item
+        t = item['description']
+        t && t.unpack('U*').map{ |c| "&##{c};" }.join
+      end
+
+      def gw2
+        Client.new(:access_token => ENV['ACCESS_TOKEN'],
+                   :log_method => env['rack.errors'].method(:puts),
+                   :cache => RestGW2.cache)
+      end
+    }
+
+    get '/bank' do
+      @items = gw2.with_item_detail('account/bank')
+      render 'bank'
+    end
+  end
+
+  Server = Jellyfish::Builder.app do
+    use Rack::CommonLogger
+    use Rack::Chunked
+    use Rack::ContentLength
+    use Rack::Deflater
+    use Rack::ContentType, 'text/html; charset=utf-8'
+
+    map '/assets' do
+      run Rack::Directory.new('public')
+    end
+
+    map '/' do
+      run ServerCore.new
+    end
+  end
+end

data/lib/rest-gw2/view/bank.erb

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN" "http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="zh-TW">
+  <head profile="http://www.w3.org/2005/10/profile">
+    <meta http-equiv="Content-Type" content="application/xhtml+xml; charset=utf-8"/>
+    <meta name="description" content="godfat.org"/>
+    <meta name="viewport" content="width=device-width, initial-scale=1"/>
+    <title>GW2 Bank</title>
+  </head>
+  <body>
+    <ul>
+      <% @items.each do |item| %>
+        <li>
+          <% if item %>
+            <img src="<%= item['icon'] %>" style="width:64px; height:64px"
+                 title="<%= item_title(item) %>"/>
+            (<%= item['count'] %>) <%= item['name'] %>
+          <% else %>
+            N/A
+          <% end %>
+        </li>
+      <% end %>
+    </ul>
+  </body>
+</html>

data/rest-gw2.gemspec

@@ -0,0 +1,43 @@
+# -*- encoding: utf-8 -*-
+# stub: rest-gw2 0.1.0 ruby lib
+
+Gem::Specification.new do |s|
+  s.name = "rest-gw2"
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.require_paths = ["lib"]
+  s.authors = ["Lin Jen-Shin (godfat)"]
+  s.date = "2015-11-14"
+  s.description = "A very simple [Guild Wars 2 API](https://wiki.guildwars2.com/wiki/API:Main)\nclient built with [rest-core](https://github.com/godfat/rest-core).\n\nThere's also a bundled web application showing your items, serving as an\nexample using the client."
+  s.email = ["godfat (XD) godfat.org"]
+  s.files = [
+  ".gitignore",
+  ".gitmodules",
+  "README.md",
+  "Rakefile",
+  "config.ru",
+  "lib/rest-gw2.rb",
+  "lib/rest-gw2/client.rb",
+  "lib/rest-gw2/server.rb",
+  "lib/rest-gw2/view/bank.erb",
+  "rest-gw2.gemspec",
+  "task/README.md",
+  "task/gemgem.rb"]
+  s.homepage = "https://github.com/godfat/rest-gw2"
+  s.licenses = ["Apache License 2.0"]
+  s.rubygems_version = "2.5.0"
+  s.summary = "A very simple [Guild Wars 2 API](https://wiki.guildwars2.com/wiki/API:Main)"
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 4
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<rest-core>, [">= 0"])
+    else
+      s.add_dependency(%q<rest-core>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<rest-core>, [">= 0"])
+  end
+end

data/task/README.md

@@ -0,0 +1,54 @@
+# Gemgem
+
+## DESCRIPTION:
+
+Provided tasks:
+
+    rake clean        # Remove ignored files
+    rake gem:build    # Build gem
+    rake gem:install  # Install gem
+    rake gem:release  # Release gem
+    rake gem:spec     # Generate gemspec
+    rake test         # Run tests in memory
+
+## REQUIREMENTS:
+
+* Tested with MRI (official CRuby) 1.9.3, 2.0.0, Rubinius and JRuby.
+
+## INSTALLATION:
+
+    git submodule add git://github.com/godfat/gemgem.git task
+
+And in Rakefile:
+
+``` ruby
+begin
+  require "#{dir = File.dirname(__FILE__)}/task/gemgem"
+rescue LoadError
+  sh 'git submodule update --init'
+  exec Gem.ruby, '-S', $PROGRAM_NAME, *ARGV
+end
+
+Gemgem.init(dir) do |s|
+  s.name    = 'your-gem'
+  s.version = '0.1.0'
+end
+```
+
+## LICENSE:
+
+Apache License 2.0
+
+Copyright (c) 2011-2013, Lin Jen-Shin (godfat)
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+<http://www.apache.org/licenses/LICENSE-2.0>
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

data/task/gemgem.rb

@@ -0,0 +1,316 @@
+
+module Gemgem
+  class << self
+    attr_accessor :dir, :spec, :spec_create
+  end
+
+  module_function
+  def gem_tag    ; "#{spec.name}-#{spec.version}"     ; end
+  def gem_path   ; "#{pkg_dir}/#{gem_tag}.gem"        ; end
+  def spec_path  ; "#{dir}/#{spec.name}.gemspec"      ; end
+  def pkg_dir    ; "#{dir}/pkg"                       ; end
+  def escaped_dir; @escaped_dir ||= Regexp.escape(dir); end
+
+  def init dir, &block
+    self.dir = dir
+    $LOAD_PATH.unshift("#{dir}/lib")
+    ENV['RUBYLIB'] = "#{dir}/lib:#{ENV['RUBYLIB']}"
+    ENV['PATH']    = "#{dir}/bin:#{ENV['PATH']}"
+    self.spec_create = block
+  end
+
+  def create
+    spec = Gem::Specification.new do |s|
+      s.authors     = ['Lin Jen-Shin (godfat)']
+      s.email       = ['godfat (XD) godfat.org']
+
+      s.description = description.join
+      s.summary     = description.first
+      s.license     = readme['LICENSE'].sub(/.+\n\n/, '').lines.first.strip
+
+      s.date        = Time.now.strftime('%Y-%m-%d')
+      s.files       = gem_files
+      s.test_files  = test_files
+      s.executables = bin_files
+    end
+    spec_create.call(spec)
+    spec.homepage ||= "https://github.com/godfat/#{spec.name}"
+    self.spec = spec
+  end
+
+  def gem_install
+    require 'rubygems/commands/install_command'
+    # read ~/.gemrc
+    Gem.use_paths(Gem.configuration[:gemhome], Gem.configuration[:gempath])
+    Gem::Command.extra_args = Gem.configuration[:gem]
+
+    # setup install options
+    cmd = Gem::Commands::InstallCommand.new
+    cmd.handle_options([])
+
+    # install
+    install = Gem::Installer.new(gem_path, cmd.options)
+    install.install
+    puts "\e[35mGem installed: \e[33m#{strip_path(install.gem_dir)}\e[0m"
+  end
+
+  def gem_spec
+    create
+    write
+  end
+
+  def gem_build
+    require 'fileutils'
+    require 'rubygems/package'
+    gem = nil
+    Dir.chdir(dir) do
+      gem = Gem::Package.build(Gem::Specification.load(spec_path))
+      FileUtils.mkdir_p(pkg_dir)
+      FileUtils.mv(gem, pkg_dir) # gem is relative path, but might be ok
+    end
+    puts "\e[35mGem built: \e[33m#{strip_path("#{pkg_dir}/#{gem}")}\e[0m"
+  end
+
+  def gem_release
+    sh_git('tag', gem_tag)
+    sh_git('push')
+    sh_git('push', '--tags')
+    sh_gem('push', gem_path)
+  end
+
+  def gem_check
+    unless git('status', '--porcelain').empty?
+      puts("\e[35mWorking copy is not clean.\e[0m")
+      exit(3)
+    end
+
+    ver = spec.version.to_s
+
+    if ENV['VERSION'].nil?
+      puts("\e[35mExpected "                                  \
+           "\e[33mVERSION\e[35m=\e[33m#{ver}\e[0m")
+      exit(1)
+
+    elsif ENV['VERSION'] != ver
+      puts("\e[35mExpected \e[33mVERSION\e[35m=\e[33m#{ver} " \
+           "\e[35mbut got\n         "                         \
+           "\e[33mVERSION\e[35m=\e[33m#{ENV['VERSION']}\e[0m")
+      exit(2)
+    end
+  end
+
+  def test
+    return if test_files.empty?
+
+    if ENV['COV'] || ENV['CI']
+      require 'simplecov'
+      if ENV['CI']
+        begin
+          require 'coveralls'
+          SimpleCov.formatter = Coveralls::SimpleCov::Formatter
+        rescue LoadError => e
+          puts "Cannot load coveralls, skip: #{e}"
+        end
+      end
+      SimpleCov.start do
+        add_filter('test/')
+        add_filter('test.rb')
+      end
+    end
+
+    test_files.each{ |file| require "#{dir}/#{file[0..-4]}" }
+  end
+
+  def clean
+    return if ignored_files.empty?
+
+    require 'fileutils'
+    trash = File.expand_path("~/.Trash/#{spec.name}")
+    puts "Move the following files into: \e[35m#{strip_path(trash)}\e[33m"
+
+    ignored_files.each do |file|
+      from = "#{dir}/#{file}"
+      to   = "#{trash}/#{File.dirname(file)}"
+      puts strip_path(from)
+
+      FileUtils.mkdir_p(to)
+      FileUtils.mv(from, to)
+    end
+
+    print "\e[0m"
+  end
+
+  def write
+    File.open(spec_path, 'w'){ |f| f << split_lines(spec.to_ruby) }
+  end
+
+  def split_lines ruby
+    ruby.gsub(/(.+?)\s*=\s*\[(.+?)\]/){ |s|
+      if $2.index(',')
+        "#{$1} = [\n  #{$2.split(',').map(&:strip).join(",\n  ")}]"
+      else
+        s
+      end
+    }
+  end
+
+  def strip_path path
+    strip_home_path(strip_cwd_path(path))
+  end
+
+  def strip_home_path path
+    path.sub(ENV['HOME'], '~')
+  end
+
+  def strip_cwd_path path
+    path.sub(Dir.pwd, '.')
+  end
+
+  def git *args
+    `git --git-dir=#{dir}/.git #{args.join(' ')}`
+  end
+
+  def sh_git *args
+    Rake.sh('git', "--git-dir=#{dir}/.git", *args)
+  end
+
+  def sh_gem *args
+    Rake.sh(Gem.ruby, '-S', 'gem', *args)
+  end
+
+  def glob path=dir
+    Dir.glob("#{path}/**/*", File::FNM_DOTMATCH)
+  end
+
+  def readme
+    @readme ||=
+      if (path = "#{Gemgem.dir}/README.md") && File.exist?(path)
+        ps = "##{File.read(path)}".
+             scan(/((#+)[^\n]+\n\n.+?(?=(\n\n\2[^#\n]+\n)|\Z))/m).map(&:first)
+        ps.inject('HEADER' => ps.first){ |r, s, i|
+          r[s[/\w+/]] = s
+          r
+        }
+      else
+        {}
+      end
+  end
+
+  def description
+    # JRuby String#lines is returning an enumerator
+    @description ||= (readme['DESCRIPTION']||'').sub(/.+\n\n/, '').lines.to_a
+  end
+
+  def all_files
+    @all_files ||= fold_files(glob).sort
+  end
+
+  def fold_files files
+    files.inject([]){ |r, path|
+      if File.file?(path) && path !~ %r{/\.git(/|$)}  &&
+         (rpath = path[%r{^#{escaped_dir}/(.*$)}, 1])
+        r << rpath
+      elsif File.symlink?(path) # walk into symlinks...
+        r.concat(fold_files(glob(File.expand_path(path,
+                                                  File.readlink(path)))))
+      else
+        r
+      end
+    }
+  end
+
+  def gem_files
+    @gem_files ||= all_files.reject{ |f|
+      f =~ ignored_pattern && !git_files.include?(f)
+    }
+  end
+
+  def test_files
+    @test_files ||= gem_files.grep(%r{^test/(.+?/)*test_.+?\.rb$})
+  end
+
+  def bin_files
+    @bin_files ||= gem_files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  end
+
+  def git_files
+    @git_files ||= if File.exist?("#{dir}/.git")
+                     git('ls-files').split("\n")
+                   else
+                     []
+                   end
+  end
+
+  def ignored_files
+    @ignored_files ||= all_files.grep(ignored_pattern)
+  end
+
+  def ignored_pattern
+    @ignored_pattern ||= if gitignore.empty?
+                           /^$/
+                         else
+                           Regexp.new(expand_patterns(gitignore).join('|'))
+                         end
+  end
+
+  def expand_patterns pathes
+    # http://git-scm.com/docs/gitignore
+    pathes.flat_map{ |path|
+      # we didn't implement negative pattern for now
+      Regexp.escape(path).sub(%r{^/}, '^').gsub(/\\\*/, '[^/]*')
+    }
+  end
+
+  def gitignore
+    @gitignore ||= if File.exist?(path = "#{dir}/.gitignore")
+                     File.read(path).lines.
+                       reject{ |l| l == /^\s*(#|\s+$)/ }.map(&:strip)
+                   else
+                     []
+                   end
+  end
+end
+
+namespace :gem do
+
+desc 'Install gem'
+task :install => [:build] do
+  Gemgem.gem_install
+end
+
+desc 'Build gem'
+task :build => [:spec] do
+  Gemgem.gem_build
+end
+
+desc 'Generate gemspec'
+task :spec do
+  Gemgem.gem_spec
+end
+
+desc 'Release gem'
+task :release => [:spec, :check, :build] do
+  Gemgem.gem_release
+end
+
+task :check do
+  Gemgem.gem_check
+end
+
+end # of gem namespace
+
+desc 'Run tests'
+task :test do
+  Gemgem.test
+end
+
+desc 'Trash ignored files'
+task :clean => ['gem:spec'] do
+  Gemgem.clean
+end
+
+task :default do
+  # Is there a reliable way to do this in the current process?
+  # It failed miserably before between Rake versions...
+  exec "#{Gem.ruby} -S #{$PROGRAM_NAME} -f #{Rake.application.rakefile} -T"
+end

metadata

@@ -0,0 +1,75 @@
+--- !ruby/object:Gem::Specification
+name: rest-gw2
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Lin Jen-Shin (godfat)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-11-14 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rest-core
+  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'
+description: |-
+  A very simple [Guild Wars 2 API](https://wiki.guildwars2.com/wiki/API:Main)
+  client built with [rest-core](https://github.com/godfat/rest-core).
+
+  There's also a bundled web application showing your items, serving as an
+  example using the client.
+email:
+- godfat (XD) godfat.org
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".gitmodules"
+- README.md
+- Rakefile
+- config.ru
+- lib/rest-gw2.rb
+- lib/rest-gw2/client.rb
+- lib/rest-gw2/server.rb
+- lib/rest-gw2/view/bank.erb
+- rest-gw2.gemspec
+- task/README.md
+- task/gemgem.rb
+homepage: https://github.com/godfat/rest-gw2
+licenses:
+- Apache License 2.0
+metadata: {}
+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.0
+signing_key: 
+specification_version: 4
+summary: A very simple [Guild Wars 2 API](https://wiki.guildwars2.com/wiki/API:Main)
+test_files: []