rest-gw2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: db66e083f2389a6f7e6607b09b3cebc8acf62037
-  data.tar.gz: 09e66dee7a294ef69d94fe9de9f273cb08aa59b0
+  metadata.gz: 82b050b4c2120f41a06311ef37c84492054fbd43
+  data.tar.gz: c4ce7c1508cbc82537f06c40b8a16c6685547776
 SHA512:
-  metadata.gz: 673e5d69c6e911e91da4f32c6625ab77791be6edaf9e56bd8e739a6f5cc25f73a4132cff3b0710ac5acb99202e42c16557a5009262f1fd2953b13f481f81e250
-  data.tar.gz: e13ea78cd360116df6308f6a776a0e1505f51dda8c12d39b49889a24662c2d27cc92f928f8aaf961167d7f39635d35354deddd96c076a34240ee5370ef8311a1
+  metadata.gz: 0778f5b31db7b67f567bc2a4c85e78c5fba06053c5dc3cf37719cde12ec2b1eccb1d8f885931ae015a395266deb25fd8602f78e5b03a610b2a5b237d2681a380
+  data.tar.gz: 9f2a5abd8b652dd5e1d779fc84ec7dc648c7ff419bec097a30f2457521eb910ff4dd35bdffede528df53fb403b21711006033af795e8d58af40cf11eae9c6743

data/.gitmodules

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

data/CHANGES.md

@@ -0,0 +1,28 @@
+# CHANGES
+
+## rest-gw2 0.2.0 -- 2015-12-18
+
+### RestGW2::Client
+
+* Changed default site so that it doesn't contain `v2`.
+* Changed default timeout from 10 seconds to 30 seconds.
+* Changed default cache from 10 minutes to 1 day.
+* Now we have `RestGW2::Error` instead of `RuntimeError`.
+* Added `RestGW2::Client#account_with_detail`
+* Added `RestGW2::Client#wallet_with_detail`
+* Added `RestGW2::Client#transactions_with_detail`
+* Added `RestGW2::Client#transactions_with_detail_compact`
+* Now `with_item_detail` would also return commerce data.
+* Now `with_item_detail` would fetch 100 items in a request.
+* Now `with_item_detail` could take a query and option.
+
+### RestGW2::Server
+
+* Added a command line tool `rest-gw2` for launching the bundled server.
+* Many stuffs are implemented now.
+* Pages are much more beautiful now.
+* We could also use lru_redux for caching, other than memcached.
+
+## rest-gw2 0.1.0 -- 2015-11-14
+
+* Birthday!

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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/README.md

@@ -25,12 +25,26 @@ example using the client.
 
 * Tested with MRI (official CRuby), Rubinius and JRuby.
 * rest-core
-* jellyfish (only for web application)
+
+### REQUIREMENTS: (if you need the web application)
+
+* rack
+* jellyfish
+* dalli (optional for memcached)
+* lru_redux (optional for LRU cache)
 
 ## INSTALLATION:
 
     gem install rest-gw2
 
+## INSTALLATION: (if you need the web application)
+
+    gem install rest-gw2 rack jellyfish
+    gem install dalli     # if you have memcached
+    gem install lru_redux # if you don't have memcached
+    gem install puma      # for a faster server which also works for JRuby
+    gem install yahns rack-handlers # slightly faster than puma, CRuby only
+
 ## SYNOPSIS:
 
 ``` ruby
@@ -39,19 +53,32 @@ gw2 = RestGW2::Client.new(:access_token => '...')
 gw2.get('account/bank') # => list of items in your bank
 ```
 
-## Bundled Web Application:
+## SYNOPSIS: (if you need the web application)
 
 If you would like to try it, run with:
 
-    env ACCESS_TOKEN=... rest-gw2-server
+    env RESTGW2_SECRET=... rest-gw2
 
-Or you could put your access token in a config file and point it with:
+The secret would be used for encrypting the access token. If you don't
+set it then it would just use the default secret, which basically means
+no encrypting at all, because the default secret is hard coded in the
+source, which is publicly available because this is an open source project.
 
-    env RESTGW2_CONFIG=... rest-gw2-server
+Or you could put your secret in a config file and point it with:
+
+    env RESTGW2_CONFIG=... rest-gw2
 
 The format for the config file would be like:
 
-    ACCESS_TOKEN=...
+    RESTGW2_SECRET=...
+    RESTGW2_PREFIX=...
+
+## DVELOPMENT:
+
+    git clone git@github.com:godfat/rest-gw2.git
+    cd rest-gw2
+    gem install rack jellyfish lru_redux yahns rack-handlers
+    ruby -Ilib:rest-core/lib -S bin/rest-gw2
 
 ## CONTRIBUTORS:
 

data/Rakefile

@@ -7,7 +7,13 @@ rescue LoadError
 end
 
 Gemgem.init(dir) do |s|
+  require 'rest-gw2/version'
   s.name    = 'rest-gw2'
-  s.version = '0.1.0'
-  %w[rest-core].each{ |g| s.add_runtime_dependency(g) }
+  s.version = RestGW2::VERSION
+  s.add_runtime_dependency('rest-core', '>=3.5.92')
+  %w[jellyfish rack rack-handlers
+     dalli lru_redux].each{ |g| s.add_development_dependency(g) }
+
+  # exclude rest-core
+  s.files.reject!{ |f| f.start_with?('rest-core/') }
 end

data/bin/rest-gw2

@@ -0,0 +1,4 @@
+#!/usr/bin/env ruby
+
+require 'rest-gw2/server/runner'
+RestGW2::Runner.run(ARGV)

data/config.ru

@@ -1,3 +1,6 @@
 
 require 'rest-gw2'
+warmup do
+  RestGW2::Client.new
+end
 run RestGW2::Server

data/lib/rest-gw2/client.rb

@@ -3,30 +3,153 @@ require 'rest-core'
 
 module RestGW2
   Client = RC::Builder.client do
-    use RC::DefaultSite   , 'https://api.guildwars2.com/v2/'
+    use RC::DefaultSite   , 'https://api.guildwars2.com/'
     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::Timeout       , 30
+    use RC::ErrorHandler  , lambda{ |env| RestGW2::Error.call(env) }
     use RC::ErrorDetectorHttp
 
     use RC::JsonResponse  , true
     use RC::CommonLogger  , nil
-    use RC::Cache         , nil, 600
+    use RC::Cache         , nil, 86400
+  end
+
+  class Error < RestCore::Error
+    include RestCore
+
+    class ServerError         < Error; end
+    class ClientError         < Error; end
+
+    class BadRequest          < ClientError; end
+    class Unauthorized        < ClientError; end
+    class Forbidden           < ClientError; end
+    class NotFound            < ClientError; end
+
+    class InternalServerError < ServerError; end
+    class BadGateway          < ServerError; end
+    class ServiceUnavailable  < ServerError; end
+
+    attr_reader :error, :code, :url
+    def initialize error, code, url=''
+      @error, @code, @url = error, code, url
+      super("[#{code}] #{error.inspect} from #{url}")
+    end
+
+    def self.call env
+      error, code, url = env[RESPONSE_BODY], env[RESPONSE_STATUS],
+                         env[REQUEST_URI]
+      return new(error, code, url) unless error.kind_of?(Hash)
+      case code
+        when 400; BadRequest
+        when 401; Unauthorized
+        when 403; Forbidden
+        when 404; NotFound
+        when 500; InternalServerError
+        when 502; BadGateway
+        when 503; ServiceUnavailable
+        else    ; self
+      end.new(error, code, url)
+    end
   end
 
   Client.include(Module.new{
-    def with_item_detail path, query={}
-      items = get(path, query)
+    # https://wiki.guildwars2.com/wiki/API:2/account
+    # https://wiki.guildwars2.com/wiki/API:2/worlds
+    # https://wiki.guildwars2.com/wiki/API:1/guild_details
+    def account_with_detail opts={}
+      me = get('v2/account', {}, opts)
+      worlds = get('v2/worlds', :ids => me['world'])
+      guilds = guilds_detail(me['guilds'])
+      me.merge('world' => world_detail(worlds.first), 'guilds' => guilds)
+    end
+
+    # https://wiki.guildwars2.com/wiki/API:2/account/wallet
+    # https://wiki.guildwars2.com/wiki/API:2/currencies
+    def wallet_with_detail opts={}
+      wallet = get('v2/account/wallet', {}, opts)
+      ids = wallet.map{ |w| w['id'] }.join(',')
+      currencies = get('v2/currencies', :ids => ids).group_by{ |w| w['id'] }
+      wallet.map do |currency|
+        currency.merge(currencies[currency['id']].first)
+      end.sort_by{ |c| c['order'] }
+    end
+
+    # https://wiki.guildwars2.com/wiki/API:2/items
+    # https://wiki.guildwars2.com/wiki/API:2/commerce/prices
+    def with_item_detail path, query={}, opts={}, &block
+      block ||= :itself.to_proc
+      items = block.call(get(path, query, opts))
       ids   = items.map{ |i| i && i['id'] }
 
-      detail = ids.compact.each_slice(5).map do |slice|
-        get('items', :ids => slice.join(','))
+      detail = ids.compact.each_slice(100).map do |slice|
+        query = {:ids => slice.join(',')}
+        [get('v2/items', query),
+         get('v2/commerce/prices', query, opts)]
       end.flatten.group_by{ |i| i['id'] }
 
-      items.map{ |i| i && detail[i['id']].first.merge('count' => i['count']) }
+      items.map do |i|
+        i && detail[i['id']].inject(i, &:merge).merge('count' => i['count'])
+      end
+    end
+
+    # https://wiki.guildwars2.com/wiki/API:2/commerce/transactions
+    def transactions_with_detail path, query={}, opts={}
+      with_item_detail("v2/commerce/transactions/#{path}",
+                       {:page_size => 200}.merge(query), opts) do |trans|
+        trans.map do |t|
+          t.merge('id' => t['item_id'], 'count' => t['quantity'])
+        end
+      end
+    end
+
+    def transactions_with_detail_compact path, query={}, opts={}
+      transactions_with_detail(path, query, opts).inject([]) do |ret, trans|
+        last = ret.last
+        if last && last['item_id'] == trans['item_id'] &&
+                   last['price']   == trans['price']
+           last['count'] += trans['count']
+        else
+          ret << trans
+        end
+        ret
+      end
+    end
+
+    private
+    # https://wiki.guildwars2.com/wiki/API:2/worlds
+    def world_detail world
+      region = case r = world['id'] / 1000
+               when 1
+                 'North America'
+               when 2
+                 'Europe'
+               else
+                 "Unknown (#{r})"
+               end
+      lang   = case r = (world['id'] % 1000) / 100
+               when 0
+                 'English'
+               when 1
+                 'French'
+               when 2
+                 'German'
+               when 3
+                 'Spanish'
+               else
+                 "Unknown (#{r})"
+               end
+      "#{world['name']} (#{world['population']}) / #{region} (#{lang})"
+    end
+
+    # https://wiki.guildwars2.com/wiki/API:1/guild_details
+    def guilds_detail guilds
+      guilds.map do |gid|
+        get('v1/guild_details', :guild_id => gid)
+      end.map do |guild|
+        "#{guild['guild_name']} [#{guild['tag']}]"
+      end
     end
   })
 end