google_apps_oauth2 0.1

data/Rakefile

@@ -0,0 +1,5 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/google_apps_oauth2.gemspec

@@ -0,0 +1,20 @@
+Gem::Specification.new do |spec|
+  spec.name = 'google_apps_oauth2'
+  spec.version = '0.1'
+  spec.license = "MIT"
+  spec.summary = 'Google Apps APIs using OAuth2'
+  spec.description = 'Library for interfacing with Google Apps Domain and Application APIs via OAuth2'
+  spec.authors = ['Will Read']
+  spec.files = Dir.glob(File.join('**', 'lib', '**', '*.rb'))
+  spec.homepage = 'https://github.com/TildeWill/google_apps'
+
+  spec.add_dependency('libxml-ruby', '>= 2.2.2')
+  spec.add_dependency('httparty')
+
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec'
+  spec.add_development_dependency 'webmock'
+
+  spec.files = `git ls-files`.split("\n")
+  spec.test_files = `git ls-files -- {test,spec,features}/*`.split("\n")
+end

data/lib/google_apps_oauth2.rb

@@ -0,0 +1,7 @@
+require 'google_apps_oauth2/parsers/feed_parser'
+require 'google_apps_oauth2/transport'
+require 'google_apps_oauth2/atom/atom'
+require 'google_apps_oauth2/atom/node'
+require 'google_apps_oauth2/atom/document'
+require 'google_apps_oauth2/atom/feed'
+require 'google_apps_oauth2/atom/user'

data/lib/google_apps_oauth2/atom/atom.rb

@@ -0,0 +1,26 @@
+require 'libxml'
+
+module GoogleAppsOauth2
+  module Atom
+    include LibXML
+
+    NAMESPACES = {
+      atom: 'http://www.w3.org/2005/Atom',
+      apps: 'http://schemas.google.com/apps/2006',
+      gd: 'http://schemas.google.com/g/2005',
+      openSearch: 'http://a9.com/-/spec/opensearchrss/1.0/'
+    }
+
+    CATEGORY = {
+      user: [['scheme', 'http://schemas.google.com/g/2005#kind'], ['term', 'http://schemas.google.com/apps/2006#user']],
+    }
+
+    ENTRY_TAG = ["<atom:entry xmlns:atom=\"#{NAMESPACES[:atom]}\" xmlns:apps=\"#{NAMESPACES[:apps]}\" xmlns:gd=\"#{NAMESPACES[:gd]}\">", '</atom:entry>']
+
+    def user(*args)
+      User.new *args
+    end
+
+    module_function :user
+  end
+end

data/lib/google_apps_oauth2/atom/document.rb

@@ -0,0 +1,46 @@
+module GoogleAppsOauth2
+  module Atom
+    class Document
+      include Node
+
+      def initialize(doc, map = {})
+        @doc = parse(doc)
+        @map = map
+      end
+
+      def parse(xml)
+        document = Atom::XML::Document.string(xml)
+        Atom::XML::Parser.document(document).parse
+      end
+
+      # find_values searches @doc and assigns any values
+      # to their corresponding instance variables.  This is
+      # useful when we've been given a string of XML and need
+      # internal consistency in the object.
+      #
+      # find_values
+      def find_values
+        @doc.root.each do |entry|
+          intersect = @map.keys & entry.attributes.to_h.keys.map(&:to_sym)
+          set_instances(intersect, entry) unless intersect.empty?
+        end
+      end
+
+      # Sets instance variables in the current object based on
+      # values found in the XML document and the mapping specified
+      # in GoogleApps::Atom::MAPS
+
+      # @param [Array] intersect
+      # @param [LibXML::XML::Node] node
+      # @param [Hash] map
+      #
+      # @visibility public
+      # @return
+      def set_instances(intersect, node)
+        intersect.each do |attribute|
+          instance_variable_set "@#{@map[attribute]}", check_value(node.attributes[attribute])
+        end
+      end
+    end
+  end
+end

data/lib/google_apps_oauth2/atom/feed.rb

@@ -0,0 +1,90 @@
+module GoogleAppsOauth2
+  module Atom
+    class Feed < Document
+      attr_reader :doc, :items, :next_page
+      def initialize(body)
+        super(body)
+
+        @items = entries_from(document: @doc, entry_tag: 'entry')
+      end
+
+      def entries_from(properties)
+        properties[:document].root.inject([]) do |results, entry|
+          if entry.name == properties[:entry_tag]
+            results << new_doc(node_to_ary(entry), ['apps:', 'atom:', 'gd:'])
+          end
+          set_next_page(entry) if entry.name == 'link' and entry.attributes[:rel] == 'next'
+          results
+        end
+      end
+
+      def set_next_page(node)
+        @next_page = node.attributes[:href]
+      end
+
+      # node_to_ary converts a Atom::XML::Node to an array.
+      #
+      # node_to_ary node
+      #
+      # node_to_ary returns the string representation of the
+      # given node split on \n.
+      def node_to_ary(node)
+        node.to_s.split("\n")
+      end
+
+      # new_doc creates a new Atom document from the data
+      # provided in the feed.  new_doc takes a type, an
+      # array of content to be placed into the document
+      # as well as an array of filters.
+      #
+      # new_doc 'user', content_array, ['apps:']
+      #
+      # new_doc returns an GoogleApps::Atom document of the
+      # specified type.
+      def new_doc(content_array, filters)
+        content_array = filters.map do |filter|
+          grab_elements(content_array, filter)
+        end
+
+        add_category(content_array)
+
+        Atom.send :user, entry_wrap(content_array.flatten).join("\n")
+      end
+
+      # add_category adds the proper atom:category node to the
+      # content_array
+      #
+      # add_category content_array, 'user'
+      #
+      # add_category returns the modified content_array
+      def add_category(content_array)
+        content_array.unshift(create_node(type: 'atom:category', attrs: Atom::CATEGORY[:user]).to_s)
+      end
+
+      # grab_elements applies the specified filter to the
+      # provided array.  Google's feed provides a lot of data
+      # that we don't need in an entry document.
+      #
+      # grab_elements content_array, 'apps:'
+      #
+      # grab_elements returns an array of items from content_array
+      # that match the given filter.
+      def grab_elements(content_array, filter)
+        content_array.grep(Regexp.new filter)
+      end
+
+      # entry_wrap adds atom:entry opening and closing tags
+      # to the provided content_array and the beginning and
+      # end.
+      #
+      # entry_wrap content_array
+      #
+      # entry_wrap returns an array with an opening atom:entry
+      # element prepended to the front and a closing atom:entry
+      # tag appended to the end.
+      def entry_wrap(content_array)
+        content_array.unshift(Atom::ENTRY_TAG[0]).push(Atom::ENTRY_TAG[1])
+      end
+    end
+  end
+end

data/lib/google_apps_oauth2/atom/node.rb

@@ -0,0 +1,57 @@
+module GoogleAppsOauth2
+  module Atom
+    module Node
+
+      # create_node takes a hash of properties from which to
+      # build the XML node.  The properties hash must have
+      # a :type key, it is also possible to pass an :attrs
+      # key with an array of attribute name, value pairs.
+      #
+      # create_node type: 'apps:property', attrs: [['name', 'Tim'], ['userName', 'tim@bob.com']]
+      #
+      # create_node returns an Atom::XML::Node with the specified
+      # properties.
+      def create_node(properties)
+        if properties[:attrs]
+          add_attributes Atom::XML::Node.new(properties[:type]), properties[:attrs]
+        else
+          Atom::XML::Node.new properties[:type]
+        end
+      end
+
+
+      # add_attributes adds the specified attributes to the
+      # given node.  It takes a LibXML::XML::Node and an
+      # array of name, value attribute pairs.
+      #
+      # add_attribute node, [['title', 'emperor'], ['name', 'Napoleon']]
+      #
+      # add_attribute returns the modified node.
+      def add_attributes(node, attributes)
+        attributes.each do |attribute|
+          node.attributes[attribute[0]] = attribute[1]
+        end
+
+        node
+      end
+
+      # Returns true if "true" and false if "false"
+
+      #
+      # @param [String] value
+      #
+      # @visibility public
+      # @return
+      def check_value(value)
+        case value
+          when 'true'
+            true
+          when 'false'
+            false
+          else
+            value
+        end
+      end
+    end
+  end
+end

data/lib/google_apps_oauth2/atom/user.rb

@@ -0,0 +1,21 @@
+module GoogleAppsOauth2
+	module Atom
+  	class User < Document
+      attr_reader :doc, :login, :suspended, :first_name, :last_name, :quota, :password
+
+      MAP = {
+        userName: :login,
+        suspended: :suspended,
+        familyName: :last_name,
+        givenName: :first_name,
+        limit: :quota,
+        password: :password
+      }
+
+  		def initialize(xml)
+        super(xml, MAP)
+        find_values
+  		end
+  	end
+  end
+end

data/lib/google_apps_oauth2/parsers/feed_parser.rb

@@ -0,0 +1,15 @@
+require 'httparty'
+
+module GoogleAppsOauth2
+  module Parsers
+    class FeedParser < HTTParty::Parser
+      SupportedFormats = {"application/atom+xml" => :atom}
+
+      protected
+
+      def atom
+        GoogleAppsOauth2::Atom::Feed.new(body).items
+      end
+    end
+  end
+end

data/lib/google_apps_oauth2/transport.rb

@@ -0,0 +1,57 @@
+require 'cgi'
+require 'openssl'
+require 'rexml/document'
+require 'httparty'
+
+module GoogleAppsOauth2
+  class Transport
+    include HTTParty
+
+    parser GoogleAppsOauth2::Parsers::FeedParser
+
+    base_uri 'https://apps-apis.google.com/a/feeds'
+
+    def initialize(options, &block)
+      @domain = options[:domain]
+      @token = options[:token]
+      @client_id = options[:client_id]
+      @client_secret = options[:client_secret]
+      @refresh_token = options[:refresh_token]
+      @token_changed_block = block
+
+      @user_path= "/#{@domain}/user/2.0"
+    end
+
+    def get_users(options = {})
+      headers = {'content-type' => 'application/atom+xml', 'Authorization' => "OAuth #{token}"}
+
+      url = user_path + "?startUsername=#{options[:start]}"
+      response = self.class.get(url, headers: headers)
+      response = check_for_refresh(response)
+
+      response
+    end
+
+    private
+    attr_reader :user_path
+    attr_reader :domain, :token, :refresh_token, :client_id, :client_secret
+
+    def check_for_refresh(old_response)
+      response = old_response
+      if old_response.code == 401
+        data = {
+            :client_id => @client_id,
+            :client_secret => @client_secret,
+            :refresh_token => refresh_token,
+            :grant_type => "refresh_token"
+        }
+        response_json = MultiJson.load(self.class.post("https://accounts.google.com/o/oauth2/token", :body => data))
+        @token = response_json["access_token"]
+        @token_changed_block.call(@token)
+        headers = old_response.request.options[:headers].merge("Authorization" => "OAuth #{token}")
+        response = self.class.get(old_response.request.uri.to_s, headers: headers)
+      end
+      response
+    end
+  end
+end

data/spec/fixtures/invalid_token.html

@@ -0,0 +1,10 @@
+<HTML>
+<HEAD>
+    <TITLE>Token invalid - Invalid token: Stateless token expired</TITLE>
+</HEAD>
+<BODY BGCOLOR="#FFFFFF" TEXT="#000000">
+<H1>Token invalid - Invalid token: Stateless token expired</H1>
+
+<H2>Error 401</H2>
+</BODY>
+</HTML>

data/spec/fixtures/refreshed_token_response.json

@@ -0,0 +1,6 @@
+{
+  "access_token": "some-new-token",
+  "token_type": "Bearer",
+  "expires_in": 3600,
+  "id_token": "eyJhbGciOiJSUzI1NiIsImtpZCI6IjNmNDUwOTU1YzA3ZGUyZWFhNDA1OTg1NmMzOGFmYWY1OTFmMWUxYTcifQ.eyJpc3MiOiJhY2NvdW50cy5nb29nbGUuY29tIiwiY2lkIjoiNDA3NDA4NzE4MTkyLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwiYXpwIjoiNDA3NDA4NzE4MTkyLmFwcHMuZ29vZ2xldXNlcmNvbnRlbnQuY29tIiwiaGQiOiJsb29wYi5hYyIsInRva2VuX2hhc2giOiI3RnV3YXBnV1dXaWxHc1l6dm9SZURBIiwiYXRfaGFzaCI6IjdGdXdhcGdXV1dpbEdzWXp2b1JlREEiLCJ2ZXJpZmllZF9lbWFpbCI6InRydWUiLCJlbWFpbF92ZXJpZmllZCI6InRydWUiLCJlbWFpbCI6IndpbGxAbG9vcGIuYWMiLCJpZCI6IjEwMjY2MDg3NTAyMjk1NTU4OTU2MCIsInN1YiI6IjEwMjY2MDg3NTAyMjk1NTU4OTU2MCIsImF1ZCI6IjQwNzQwODcxODE5Mi5hcHBzLmdvb2dsZXVzZXJjb250ZW50LmNvbSIsImlhdCI6MTM2MTQ5ODU5OSwiZXhwIjoxMzYxNTAyNDk5fQ.HblnwmqqyQoapWIZP90QqB92MBTUQEnYRjvFRO8BaWV2VVQIgc2v1Vb_oOaChNs3w2vXk-2NQiJlWVdqDFARCRe5n3BID2wr8iwSUzVCEt4fg3rqxQ-IeXXWNYCx-32N3k7w4mcnxsnglw7ajol4vkv-2Nx8peA3Zvwt0NXdxj8"
+}

data/spec/fixtures/user.xml

@@ -0,0 +1,5 @@
+<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">
+  <atom:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/apps/2006#user"/>
+  <apps:login userName="lholcomb2" suspended="false"/>
+  <apps:name familyName="Holcomb" givenName="Lawrence"/>
+</atom:entry>

data/spec/fixtures/users_feed.xml

@@ -0,0 +1,49 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<feed xmlns='http://www.w3.org/2005/Atom' xmlns:openSearch='http://a9.com/-/spec/opensearchrss/1.0/'
+      xmlns:apps='http://schemas.google.com/apps/2006' xmlns:gd='http://schemas.google.com/g/2005'>
+  <id>https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0</id>
+  <updated>1970-01-01T00:00:00.000Z</updated>
+  <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/apps/2006#user'/>
+  <title type='text'>Users</title>
+  <link rel='http://schemas.google.com/g/2005#feed' type='application/atom+xml'
+        href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0'/>
+  <link rel='http://schemas.google.com/g/2005#post' type='application/atom+xml'
+        href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0'/>
+  <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0'/>
+  <link rel='next' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/cnm.edu/user/2.0?startUsername=aadams37'/>
+  <openSearch:startIndex>1</openSearch:startIndex>
+  <entry>
+    <id>https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0/misterunfriendly</id>
+    <updated>1970-01-01T00:00:00.000Z</updated>
+    <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/apps/2006#user'/>
+    <title type='text'>misterunfriendly</title>
+    <link rel='self' type='application/atom+xml'
+          href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0/misterunfriendly'/>
+    <link rel='edit' type='application/atom+xml'
+          href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0/misterunfriendly'/>
+    <apps:login userName='misterunfriendly' suspended='false' ipWhitelisted='false' admin='false'
+                changePasswordAtNextLogin='true' agreedToTerms='true'/>
+    <apps:quota limit='25600'/>
+    <apps:name familyName='Unfriendly' givenName='Mister'/>
+    <gd:feedLink rel='http://schemas.google.com/apps/2006#user.nicknames'
+                 href='https://apps-apis.google.com/a/feeds/loopb.ac/nickname/2.0?username=misterunfriendly'/>
+    <gd:feedLink rel='http://schemas.google.com/apps/2006#user.emailLists'
+                 href='https://apps-apis.google.com/a/feeds/loopb.ac/emailList/2.0?recipient=misterunfriendly%40loopb.ac'/>
+  </entry>
+  <entry>
+    <id>https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0/will</id>
+    <updated>1970-01-01T00:00:00.000Z</updated>
+    <category scheme='http://schemas.google.com/g/2005#kind' term='http://schemas.google.com/apps/2006#user'/>
+    <title type='text'>will</title>
+    <link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0/will'/>
+    <link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/loopb.ac/user/2.0/will'/>
+    <apps:login userName='will' suspended='false' ipWhitelisted='false' admin='true' changePasswordAtNextLogin='false'
+                agreedToTerms='true'/>
+    <apps:quota limit='25600'/>
+    <apps:name familyName='Read' givenName='Will'/>
+    <gd:feedLink rel='http://schemas.google.com/apps/2006#user.nicknames'
+                 href='https://apps-apis.google.com/a/feeds/loopb.ac/nickname/2.0?username=will'/>
+    <gd:feedLink rel='http://schemas.google.com/apps/2006#user.emailLists'
+                 href='https://apps-apis.google.com/a/feeds/loopb.ac/emailList/2.0?recipient=will%40loopb.ac'/>
+  </entry>
+</feed>

data/spec/google_apps_oauth2/atom/document_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+describe GoogleAppsOauth2::Atom::Document do
+  let (:document) { GoogleAppsOauth2::Atom::Document.new File.read('spec/fixture_xml/user.xml') }
+  let (:doc_string) { File.read('spec/fixture_xml/users_feed.xml') }
+
+  describe "#parse" do
+    it "parses the given XML document" do
+      document.parse(doc_string).should be_a LibXML::XML::Document
+    end
+  end
+
+  describe "#to_s" do
+    it "Outputs @doc as a string" do
+      document.to_s.should be_a String
+    end
+  end
+end