gimmie 0.1.2 → 0.1.3

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 96adefc62c85f11fbd123fe189b69a1ea6732152
+  data.tar.gz: e85053065882d9924b3867273cfedda7ebdad28e
+SHA512:
+  metadata.gz: 816c9b2338a114da9020897832ea5ca8110a872786b776a5c01af72222365470a3d0c8d6d82d2b4dc0b9c052a87dcd4eeb2e0e75a59ee608eaf17cbf07ce4ad2
+  data.tar.gz: 53db847184c39237554da40bd9d5f3e4069c2562cc3ce7b661e3837f24ade00bbaabc66dc8d990a52b6721b2d4f85c87a4639c5c426175da444bd53f5fa24385

metadata

@@ -1,69 +1,72 @@
 --- !ruby/object:Gem::Specification
 name: gimmie
 version: !ruby/object:Gem::Version
-  version: 0.1.2
-  prerelease: 
+  version: 0.1.3
 platform: ruby
 authors:
 - Chew Choon Keat
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-17 00:00:00.000000000 Z
+date: 2014-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rack
-  requirement: &70225282259800 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.4.5
   type: :runtime
   prerelease: false
-  version_requirements: *70225282259800
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.4.5
 - !ruby/object:Gem::Dependency
   name: oauth
-  requirement: &70225282259260 !ruby/object:Gem::Requirement
-    none: false
+  requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.4.6
   type: :runtime
   prerelease: false
-  version_requirements: *70225282259260
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.4.6
 description: Rack application to provide a reverse proxy for Gimmie REST API
 email: choonkeat@gmail.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- README.md
 - lib/gimmie.rb
 - lib/gimmie/proxy.rb
 homepage: http://gimmieworld.com
 licenses: []
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 2.4.2
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: Proxy for Gimmie API
 test_files: []

data/README.md

@@ -1,77 +0,0 @@
-# Gimmie Rack Library
-
-This gem is Rack application to provide a reverse proxy for Gimmie REST API
-
-## Installation
-
-	gem install gimmie
-
-If you are using `bundler`, add this into your `Gemfile`
-
-	gem "gimmie"
-
-### Configuration
-
-Gimmie Proxy library prefers configuration to be set as environment variables
-
-	GIMMIE_OAUTH_KEY
-	GIMMIE_OAUTH_SECRET
-	GIMMIE_COOKIE_KEY
-	GIMMIE_URL_PREFIX
-
-In this way, the `Gimmie::Proxy` object can be simply initialized as
-
-	Gimmie::Proxy.new
-
-Alternatively, configuration can be set as constructor arguments, e.g.
-
-	Gimmie::Proxy.new({
-		cookie_key: '_gm_key',
-		oauth_key: 'onetwothree',
-		oauth_secret: 'fourfivesix',
-		url_prefix: 'https://api.gimmieworld.com',
-	})
-
-### Rack
-
-Create a file `config.ru` with the following code
-
-	require 'gimmie'
-	run Gimmie::Proxy.new
-
-Next, execute the command
-
-	rackup
-
-This will run a web server on port 9292. You can test by sending a HTTP request, e.g.
-
-    curl -i 'http://localhost:9292/gimmieapi=/1/rewards.json'
-
-If your `GIMMIE_URL_PREFIX` is `https://api.gimmieworld.com`, then an OAuth request will sent to `https://api.gimmieworld.com/1/rewards.json` and the response will be echoed back
-
-### Rails
-
-To add Gimmie Proxy into your existing Rails application, simply provide a route in your `config/routes.rb` file, e.g.
-
-	match "/gimmie_proxy" => Gimmie::Proxy.new
-
-You can test by sending a HTTP request, e.g.
-
-    curl -i 'http://localhost:3000/gimmie_proxy?gimmieapi=/1/rewards.json?x=y'
-
-NOTE: the mount path can be anything, Gimmie Proxy does not care; it only looks for the `gimmieapi=` string and ignore everything that comes before.
-
-If your `GIMMIE_URL_PREFIX` is `https://api.gimmieworld.com`, then an OAuth request will sent to `https://api.gimmieworld.com/1/rewards.json?x=y` and the response will be echoed back
-
-## What's this proxy for?
-
-Talking to [Gimmie APIs](https://portal.gimmieworld.com/documentation/json) from the server-side should not be an issue for most developers since the technology stack consists of standards like `HTTP`, `OAuth` and `JSON`.
-
-However, client apps that run on the browser would have problems securing their `OAuth` credentials. The solution is to run a reverse proxy on your own infrastructure and have the client apps talk (without OAuth) to the OAuth configured reverse proxy (which would relay the request to `api.gimmieworld.com` and echo the response back to the browser)
-
-Meaning, a browser request to
-
- * `http://www.yourserver.com/some/path?gimmieapi=/1/stores.json?hello=world` would be forwarded to
- * `http://api.gimmieworld.com/1/stores.json?hello=world`
-
-When referencing the [API documentation](https://portal.gimmieworld.com/documentation/json), simply replace the url prefix `http://api.gimmieworld.com` with your own reverse proxy url. Everything will still apply as-is.