vfnetapis 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rvmrc

@@ -0,0 +1,48 @@
+#!/usr/bin/env bash
+
+# This is an RVM Project .rvmrc file, used to automatically load the ruby
+# development environment upon cd'ing into the directory
+
+# First we specify our desired <ruby>[@<gemset>], the @gemset name is optional,
+# Only full ruby name is supported here, for short names use:
+#     echo "rvm use 1.9.3" > .rvmrc
+environment_id="ruby-1.9.3-p125@vfnetapis"
+
+# Uncomment the following lines if you want to verify rvm version per project
+# rvmrc_rvm_version="1.10.3" # 1.10.1 seams as a safe start
+# eval "$(echo ${rvm_version}.${rvmrc_rvm_version} | awk -F. '{print "[[ "$1*65536+$2*256+$3" -ge "$4*65536+$5*256+$6" ]]"}' )" || {
+#   echo "This .rvmrc file requires at least RVM ${rvmrc_rvm_version}, aborting loading."
+#   return 1
+# }
+
+# First we attempt to load the desired environment directly from the environment
+# file. This is very fast and efficient compared to running through the entire
+# CLI and selector. If you want feedback on which environment was used then
+# insert the word 'use' after --create as this triggers verbose mode.
+if [[ -d "${rvm_path:-$HOME/.rvm}/environments"
+  && -s "${rvm_path:-$HOME/.rvm}/environments/$environment_id" ]]
+then
+  \. "${rvm_path:-$HOME/.rvm}/environments/$environment_id"
+  [[ -s "${rvm_path:-$HOME/.rvm}/hooks/after_use" ]] &&
+    \. "${rvm_path:-$HOME/.rvm}/hooks/after_use" || true
+else
+  # If the environment file has not yet been created, use the RVM CLI to select.
+  rvm --create  "$environment_id" || {
+    echo "Failed to create RVM environment '${environment_id}'."
+    return 1
+  }
+fi
+
+# If you use bundler, this might be useful to you:
+# if [[ -s Gemfile ]] && {
+#   ! builtin command -v bundle >/dev/null ||
+#   builtin command -v bundle | grep $rvm_path/bin/bundle >/dev/null
+# }
+# then
+#   printf "%b" "The rubygem 'bundler' is not installed. Installing it now.\n"
+#   gem install bundler
+# fi
+# if [[ -s Gemfile ]] && builtin command -v bundle >/dev/null
+# then
+#   bundle install | grep -vE '^Using|Your bundle is complete'
+# fi

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 OneAPI
+
+MIT License
+
+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,63 @@
+# Vfnetapis
+
+Simple OAUTH and OneAPI calls against Vodafone's OneAPI endpoint
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'vfnetapis'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install vfnetapis
+
+## Usage
+
+  USAGE: Initialize with Vfnetapis::Location.new(application key, callbackURI) , then location(MSISDN, requested accuracy in metres)
+  
+  The gem returns lat/long based on mobile network location, incorporating and greatly simplifying the OAUTH flow to gain user consent.
+  
+  The result is a JSON location based on the OneAPI location API, http://oneapi.gsma.com/reference-location-restful-api/
+  
+  For convenience the JSON is pre-parsed into several instance variables, see example below.
+  
+  For this version the callbackURI must points to a web service with specific routes,
+  to trap the authorization and access token flows. See https://github.com/OneAPI/NetworksAPIs/ruby/auth_trap.rb
+  for a Sinatra implementation.
+  
+  EXAMPLE:
+	require 'vfnetapis'
+	
+	# 1. run auth_trap.rb from https://github.com/OneAPI/NetworksAPIs/ruby
+	
+	# 2. initialise with your application key and use the auth_trap.rb as the callback URI
+	loc=Vfnetapis::Location.new({my_app_key},'http://localhost:4567/tokenStore')
+	
+	# 3. make the location request, params are MSISDN in tel:441234567890 format, and requested accuracy in metres 
+	loc.location({MSISDN},{metres})
+	
+	# 4. Do something with the results!
+	puts 'Results for address: ' + loc.address
+	puts 'longitude is ' + loc.longitude
+	puts 'latitude is '  + loc.latitude
+	puts 'altitude is '  + loc.altitude
+	puts 'accuracy is ' + loc.accuracy
+	puts 'timestamp is ' + loc.timestamp
+	
+	puts 'the full response is: ' + loc.response.to_s # => the raw JSON if you want it...
+	
+	puts 'the access token is: ' + loc.access_token
+	puts 'the access token expiry is: ' + loc.expires_in"
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/lib/vfnetapis/version.rb

@@ -0,0 +1,3 @@
+module Vfnetapis
+  VERSION = "0.0.1"
+end

data/lib/vfnetapis.rb

@@ -0,0 +1,80 @@
+require "vfnetapis/version"
+require 'rest-client'
+require 'JSON'
+require 'launchy'
+require 'uri'
+
+module Vfnetapis
+  class Location
+    attr_accessor :key
+    attr_accessor :redirectURI
+    attr_accessor :requestId
+    attr_accessor :auth_token
+    attr_accessor :access_token
+    attr_accessor :expires_in
+    attr_reader   :longitude
+    attr_reader   :latitude
+    attr_reader   :altitude 
+    attr_reader   :address
+    attr_reader   :accuracy
+    attr_reader   :timestamp 
+    attr_reader   :response
+    @@loc_api="http://79.125.107.189/v2/location/queries/location"
+    @@auth_server = "http://79.125.107.189/2/oauth/authorize"
+    @@acc_server = "http://176.34.213.154/2/oauth/access_token?client_id="
+    
+    def initialize(key,redirectURI) # => set up tokens ready for request
+     @scope = "GET-/location/queries/location" # "POST-/payment/acr:Authorization/transactions/amount"    
+     @key          = key
+     @redirectURI  = redirectURI
+     @requestId    = generateActivationCode()
+    end
+    
+    def location(address, requested_accuracy)
+     @auth_token   = get_auth_token(@redirectURI,@scope)
+     puts 'Auth Token is:' + @auth_token
+     @access_token = get_access_token(@auth_token)
+     puts 'Access Token is:' + @access_token
+
+     @response = RestClient.get @@loc_api, :authorization=> 'Oauth ' + @access_token, :params => {:address => URI.escape(address,':'), :requestedAccuracy => requested_accuracy}
+
+     resJson = JSON.parse(@response)
+     @longitude = resJson["terminalLocationList"]["terminalLocation"]["currentLocation"]["longitude"]
+     @latitude  = resJson["terminalLocationList"]["terminalLocation"]["currentLocation"]["latitude"]
+     @altitude  = resJson["terminalLocationList"]["terminalLocation"]["currentLocation"]["altitude"]
+     @accuracy  = resJson["terminalLocationList"]["terminalLocation"]["currentLocation"]["accuracy"]
+     @timestamp = resJson["terminalLocationList"]["terminalLocation"]["currentLocation"]["timestamp"]
+     @address   = resJson["terminalLocationList"]["terminalLocation"]["address"]
+    end
+   
+    def get_auth_token(redirectURI,scope) # => start consent flow to send code to redirectURI
+     @uri = @@auth_server + '?client_id=' + @key + '&redirect_uri=' + URI.escape(redirectURI + '/' + @requestId, '/:&\?\.@') + '&scope=' + URI.escape(scope,'/:')
+     Launchy.open(@uri) # => opens a browser to acquire consent then redirects to the callback
+     while true # => poll to check user consent received by external listener
+	   begin
+		  @auth_token = RestClient.get redirectURI + '/authToken/' + requestId
+		  break if !@auth_token.empty?
+	   rescue
+		  $stderr.puts "failed to get access token"
+		  retry
+	   end
+	   sleep 1
+	 end
+	 @auth_token
+    end  
+
+  	def get_access_token(authorizationCode)
+  	 uri = @@acc_server + @key
+  	 accessResponse = RestClient.post uri, :redirect_uri => URI.escape(redirectURI, '/:&\?\.@') , :grant_type => 'authorization_code', :response_type => 'client_credentials', :code => authorizationCode, :content_type => 'application/x-www-form-urlencoded', :accept => :json
+  	 # this needs to change in order to get the JSON back
+  	 resJson = JSON.parse(accessResponse)
+  	 @expires_in = resJson["expires_in"]
+     @accessToken = resJson["access_token"]
+    end
+    
+    def generateActivationCode(size= 6)
+     charset = %w{ 2 3 4 6 7 9 A C D E F G H J K M N P Q R T V W X Y Z}
+  	 (0...size).map{ charset.to_a[rand(charset.size)] }.join
+	end
+ end
+end

data/vfnetapis.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/vfnetapis/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["OneAPI"]
+  gem.email         = ["kevin.smith@vodafone.com"]
+  gem.description   = "OAUTH with OneAPI calls against Vodafone's OneAPI endpoint."
+  gem.summary       = "Network API helpers for reading a user's location and brokering the OAUTH dance."
+  gem.homepage      = ""
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "vfnetapis"
+  gem.require_paths = ["lib"]
+  gem.version       = Vfnetapis::VERSION
+end
+
+
+

metadata

@@ -0,0 +1,55 @@
+--- !ruby/object:Gem::Specification
+name: vfnetapis
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- OneAPI
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-03-30 00:00:00.000000000 Z
+dependencies: []
+description: OAUTH with OneAPI calls against Vodafone's OneAPI endpoint.
+email:
+- kevin.smith@vodafone.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rvmrc
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/vfnetapis.rb
+- lib/vfnetapis/version.rb
+- vfnetapis.gemspec
+homepage: ''
+licenses: []
+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.18
+signing_key: 
+specification_version: 3
+summary: Network API helpers for reading a user's location and brokering the OAUTH
+  dance.
+test_files: []