esriveter 0.0.1

data/.gitignore

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

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2013 Jen Oslislo
+
+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,54 @@
+# Esriveter
+
+  A token manager for your all yer AGO token needs. Automagically manage
+  app tokens and device tokens.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'esriveter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install esriveter
+
+## Usage
+
+    # Get a persisting app token
+    params = {client_id: 'client_id', client_secret: 'client_secret'}
+    t = Esriveter.new params
+    conn = Faraday.new(:url => geotriggers_url)
+    conn.get "/device/list?token=#{t.app_token}"
+
+    # Get a persisting device token
+    params = {client_id: 'client_id', client_secret: 'client_secret', device_id:
+    'device_id', refresh_token: 'refresh_token'}
+    t = Esriveter.new params
+    conn = Faraday.new(:url => geotriggers_url)
+    conn.get "/device/list?token=#{t.device_token}"
+
+    # If you don't specify device_id and refresh token, they'll be
+    # created for you
+    params = {client_id: 'client_id', client_secret: 'client_secret'}
+    t = Esriveter.new params
+    conn = Faraday.new(:url => geotriggers_url)
+    conn.get "/device/list?token=#{t.device_token}"
+    puts "Device: #{t.device_id}"
+
+    # Don't got an app? No prob.
+    params = {username: 'me', password: 'password', title: 'My App'}
+    t = Esriveter.new params
+    app_stuff = t.create_app
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/esriveter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'esriveter'
+
+Gem::Specification.new do |gem|
+  gem.name          = "esriveter"
+  gem.version       = "0.0.1"
+  gem.authors       = ["Jen Oslislo"]
+  gem.email         = ["poeksweb@gmail.com"]
+  gem.description   = %q{This gem creates new tokens and manages devices for you on Esri's Arcgis Online service.}
+  gem.summary       = %q{This gem creates new tokens and manages devices for you on Esri's Arcgis Online service.}
+  gem.homepage      = ""
+
+  gem.files         = `git ls-files`.split($/)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ["lib"]
+
+  gem.add_dependency 'faraday', '~>0.8.8'
+  gem.add_dependency 'multi_json', '~>1.7.9'
+  gem.add_development_dependency 'rspec'
+  gem.add_development_dependency 'faraday', '~>0.8.8'
+  gem.add_development_dependency 'multi_json', '~>1.7.9'
+end

data/lib/esriveter.rb

@@ -0,0 +1,168 @@
+class Esriveter
+
+  attr_accessor :device_token, :device_token_expiry, :refresh_token, :device_id
+  attr_accessor :app_token, :app_token_expiry
+  attr_accessor :client_id, :client_secret
+  attr_accessor :server, :debug, :force
+
+  ACCESS_TOKEN_KEY = 'access_token'  
+  EXPIRES_KEY = 'expires_in'
+  DEVICE_KEY = 'device'
+  DEVICE_TOKEN_KEY = 'deviceToken'
+  DEVICE_ID_KEY = 'deviceId'
+  REFRESH_TOKEN_KEY = 'refresh_token'
+
+  def initialize(opts={})
+    set_variables opts
+
+    @server = self.default_server if not @server
+    @client = Faraday.new do |faraday|
+      faraday.use Faraday::Request::UrlEncoded
+      faraday.use Faraday::Response::Logger if @debug
+      faraday.adapter :net_http
+    end
+    self
+  end
+
+  def get_app_token
+    if not @app_token_expiry or (not @app_token or @force or @app_token_expiry < Time.now)
+      self.create_app_token
+    end
+    {app_token: @app_token, app_token_expiry: @app_token_expiry}
+  end
+
+  def get_device_token
+    if not @device_token_expiry or (not @device_token or @force or @device_token_expiry < Time.now)
+
+      dresponse = self.create_device_token
+      if dresponse.size == 2
+        {device_token: @device_token, device_token_expiry: @device_token_expiry}
+      else
+        {device_token: @device_token, device_token_expiry: @device_token_expiry, refresh_token: @refresh_token, device_id: @device_id}
+      end
+    else 
+      {device_token: @device_token, device_token_expiry: @device_token_expiry}
+    end
+  end
+
+  def create_app username, password, title="Random Name #{Random.rand(11)}"
+
+    action = Proc.new  { |uri, params|
+      puts params.inspect if @debug
+      self.generic_request uri, params 
+    }
+
+    # Generate Token
+    params = {
+      'username' => username,
+      'password' => password,
+      'expiration' => self.desired_expiration,
+      'referer' => 'arcgis.com'
+    }
+    uri = "/rest/generateToken"
+    tresponse = action.call(uri, params)
+
+    # Add Item
+    params = {
+      'token' => tresponse['token'],
+      'type' => 'Application',
+      'title' => title 
+    }
+    uri = "/rest/content/users/#{username}/addItem"
+    iresponse = action.call(uri, params) 
+
+    # Create Application
+    params = {
+      'itemId' => iresponse['id'],
+      'appType' => 'multiple',
+      'redirect_uris' => '[]',
+      'token' => tresponse['token']
+    }
+    uri = "/oauth2/registerApp"
+    aresponse = action.call(uri, params) 
+
+    aresponse
+  end
+
+  protected
+
+  def create_app_token
+    params = {'grant_type' => 'client_credentials', 'client_id' => @client_id, 'client_secret' => @client_secret}
+    tresponse = self.generic_request "/oauth2/token", params
+    @app_token = tresponse[ACCESS_TOKEN_KEY]
+    @app_token_expiry = self.get_expiry tresponse[EXPIRES_KEY]
+
+    [@app_token, @app_token_expiry]
+  end
+
+  def create_device_token
+    if @refresh_token
+
+      params = {
+        'client_id' => @client_id,
+        'refresh_token' => @refresh_token,
+        'grant_type' => 'refresh_token'
+      }
+      tresponse = self.generic_request "/oauth2/token", params
+      @device_token = tresponse[ACCESS_TOKEN_KEY]
+      @device_token_expiry = self.get_expiry tresponse[EXPIRES_KEY]
+      [@device_token, @device_token_expiry]
+    else
+      register_device
+    end
+  end
+
+  def register_device
+
+    params = {
+      'client_id' => @client_id
+    }
+    tresponse = self.generic_request "/oauth2/registerDevice", params
+    @device_id = tresponse[DEVICE_KEY][DEVICE_ID_KEY]
+    @refresh_token = tresponse[DEVICE_TOKEN_KEY][REFRESH_TOKEN_KEY]
+    @device_token = tresponse[DEVICE_TOKEN_KEY][ACCESS_TOKEN_KEY]
+    @device_token_expiry = self.get_expiry tresponse[DEVICE_TOKEN_KEY][EXPIRES_KEY]
+
+    [@device_token, @device_token_expiry, @refresh_token, @device_id]
+  end
+
+  def generic_request path, params
+    uri = "#{self.base_uri}#{path}#{self.with_json}"
+    response = MultiJson.load  @client.post(uri, params).body
+    puts response.inspect if @debug
+    response
+  end
+
+  def set_variables vars
+    return if not vars
+    vars.each do |key, value|
+      self.send("#{key}=", value) if self.respond_to?(key)
+    end
+  end
+
+  def default_server
+    ENV["ESRIVETER_DEFAULT_SERVER"]||"arcgis.com"
+  end
+
+  def base_path
+    ENV["ESRIVETER_BASE_PATH"]||"/sharing"
+  end
+
+  def base_uri
+    "https://#{ self.server }#{self.base_path}"
+  end
+
+  def with_json
+    "?f=json"
+  end
+
+  def get_expiry seconds
+    Time.now + (seconds.to_i)
+  end
+
+  def desired_expiration
+    999999
+  end
+
+end
+

data/spec/esriveter_spec.rb

@@ -0,0 +1,60 @@
+require_relative 'spec_helper'
+system("sh ./.password")
+
+describe Esriveter do
+
+  before do
+    client_id = ENV["ESRIVETER_CLIENT_ID"]
+    client_secret = ENV["ESRIVETER_CLIENT_SECRET"] 
+    debug = false
+
+    @params = {client_id: client_id, client_secret: client_secret, debug: debug, server: 'devext.arcgis.com'}
+    @t = Esriveter.new @params
+  end
+
+  it 'should get an app token' do
+    app_res = @t.get_app_token
+    app_res.class.should == Hash
+    app_res.keys.size.should == 2
+    @t.app_token.length.should > 0
+  end
+
+  it 'should save app token among requests' do
+    first = @t.get_app_token
+    second = @t.get_app_token
+    first[:app_token].should == second[:app_token]
+  end
+
+  it 'should be able to force fresh app tokens' do
+    first = @t.get_app_token
+    @t.force = true
+    second = @t.get_app_token
+    first[:app_token].should_not == second[:app_token]
+  end
+
+  it 'should get a device token' do
+    dev_res = @t.get_device_token
+    dev_res.class.should == Hash
+    dev_res.keys.size.should == 4
+    @t.device_token.length.should > 0
+  end
+
+  it 'should save device token among requests' do
+    @t.force = false
+    first = @t.get_device_token
+    second = @t.get_device_token
+    second.class.should == Hash
+    second.keys.size.should == 2
+    first[:device_token].should == second[:device_token]
+  end
+
+  it 'should be able to force fresh device tokens' do
+    first = @t.get_device_token
+    @t.force = true
+    second = @t.get_device_token
+    first.class.should == Hash
+    first.keys.size.should == 4
+   first[:device_token].should_not == second[:device_token]
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,7 @@
+require 'rubygems'
+require 'faraday'
+require 'multi_json'
+
+require_relative '../lib/esriveter'
+
+

metadata

@@ -0,0 +1,139 @@
+--- !ruby/object:Gem::Specification
+name: esriveter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jen Oslislo
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-08-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 0.8.8
+- !ruby/object:Gem::Dependency
+  name: multi_json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: 1.7.9
+description: This gem creates new tokens and manages devices for you on Esri's Arcgis
+  Online service.
+email:
+- poeksweb@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- esriveter.gemspec
+- lib/esriveter.rb
+- spec/esriveter_spec.rb
+- spec/spec_helper.rb
+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.25
+signing_key: 
+specification_version: 3
+summary: This gem creates new tokens and manages devices for you on Esri's Arcgis
+  Online service.
+test_files:
+- spec/esriveter_spec.rb
+- spec/spec_helper.rb
+has_rdoc: