google_apps 0.5 → 0.9

data/spec/google_apps/document_handler_spec.rb

@@ -0,0 +1,48 @@
+require 'spec_helper'
+
+describe "GoogleApps::DocumentHandler" do
+  let (:handler) { GoogleApps::DocumentHandler.new }
+  let (:documents) { to_meth GoogleApps::Atom::Document.types }
+
+  describe "#create_doc" do
+    it "Returns a XML document when given xml and @format is :atom" do
+      handler.create_doc(finished_export, :export).should be_a LibXML::XML::Document
+    end
+
+    it "Returns a XML document when given xml and @format is :xml" do
+      handler.create_doc(finished_export, :export).should be_a LibXML::XML::Document
+    end
+  end
+
+  describe "#unknown_type" do
+    it "Returns an XML Document when given a string and @format is :atom" do
+      handler.unknown_type(finished_export).should be_a LibXML::XML::Document
+    end
+
+    it "Returns an XML Document when given a string and @format is :xml" do
+      handler.unknown_type(finished_export).should be_a LibXML::XML::Document
+    end
+  end
+
+  describe "#doc_of_type" do
+    it "Returns an object of the specified type if the type is valid for the format" do
+      user = handler.doc_of_type File.read('spec/fixture_xml/user.xml'), :user
+
+      user.should be_a GoogleApps::Atom::User
+    end
+
+    it "Raises a RuntimeError if the type is not valid for the format" do
+      lambda { handler.doc_of_type :goat, File.read('spec/fixture_xml/user.xml') }.should raise_error
+    end
+  end
+
+  describe "#look_up_doc_types" do
+    it "Returns a list of all Atom documents when @format is :atom" do
+      handler.send(:look_up_doc_types).should == documents
+    end
+
+    it "Returns a list of all Atom documents when @format is :xml" do
+      handler.send(:look_up_doc_types).should == documents
+    end
+  end
+end

data/spec/google_apps/transport_spec.rb

@@ -0,0 +1,235 @@
+require 'spec_helper'
+
+describe GoogleApps::Transport do
+  let (:mock_request) { mock(GoogleApps::AppsRequest) }
+  let (:mock_response) { mock(Net::HTTPResponse) }
+  let (:user_doc) { GoogleApps::Atom::User.new File.read('spec/fixture_xml/user.xml') }
+  let (:credentials) { get_credentials }
+  let (:user_name) { generate_username }
+  let (:document) { mock(GoogleApps::Atom::User).stub!(:to_s).and_return("stub xml") }
+
+  before(:each) do
+    @headers = {
+      auth: [['content-type', 'application/x-www-form-urlencoded']],
+      migration: [['content-type', "multipart/related; boundary=\"#{GoogleApps::Transport::BOUNDARY}\""], ['Authorization', "OAuth #{transporter.instance_eval { @token } }"]],
+      other: [['content-type', 'application/atom+xml'], ['Authorization', "OAuth #{transporter.instance_eval { @token } }"]]
+    }
+
+    GoogleApps::AppsRequest.stub(:new).and_return(mock_request)
+
+    mock_request.stub(:send_request).and_return(mock_response)
+    mock_request.stub(:add_body)
+  end
+
+  let(:transporter) do
+    GoogleApps::Transport.new(
+        domain: 'cnm.edu',
+        token: 'some-token',
+        refresh_token: 'refresh_token',
+        token_changed_callback: 'callback-proc'
+    )
+  end
+
+  describe '#new' do
+    it "assigns endpoints" do
+      transporter.user.should == "https://apps-apis.google.com/a/feeds/cnm.edu/user/2.0"
+      transporter.group.should == "https://apps-apis.google.com/a/feeds/group/2.0/cnm.edu"
+      transporter.nickname.should == "https://apps-apis.google.com/a/feeds/cnm.edu/nickname/2.0"
+      transporter.pubkey.should == "https://apps-apis.google.com/a/feeds/compliance/audit/publickey/cnm.edu"
+      transporter.export.should == "https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu"
+      transporter.migration.should == "https://apps-apis.google.com/a/feeds/migration/2.0/cnm.edu"
+    end
+  end
+
+  describe "#add_member_to" do
+    it "creates an HTTP POST request to add a member to a group" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:post, URI(transporter.group + '/Test/member'), @headers[:other])
+      transporter.should_receive(:success_response?).and_return(true)
+
+      mock_request.should_receive :add_body
+      mock_response.should_receive(:body).and_return("document")
+      transporter.stub(:create_doc)
+
+      transporter.add_member_to 'Test', 'Bob'
+      get_path("group")
+    end
+  end
+
+  describe "#add_owner_to" do
+    before(:each) do
+      @owner_doc = double(GoogleApps::Atom::GroupOwner)
+    end
+
+    it "adds the specified address as an owner of the specified group" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:post, URI(transporter.group + '/test_group@cnm.edu/owner'), @headers[:other])
+      transporter.add_owner_to 'test_group@cnm.edu', @owner_doc
+    end
+  end
+
+  describe "#delete_owner_from" do
+    it "Deletes the owner from the group" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:delete, URI(transporter.group + '/test_group@cnm.edu/owner/lholcomb2@cnm.edu'), @headers[:other])
+
+      transporter.delete_owner_from 'test_group@cnm.edu', 'lholcomb2@cnm.edu'
+    end
+  end
+
+  describe "#get_nicknames_for" do
+    it "Gets a feed of the nicknames for the requested user" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(transporter.nickname + '?username=lholcomb2'), @headers[:other])
+      transporter.should_receive(:success_response?).and_return(true)
+      mock_response.should_receive(:body).and_return(fake_nickname)
+
+      transporter.get_nicknames_for 'lholcomb2'
+    end
+  end
+
+  describe "#delete_member_from" do
+    it "crafts an HTTP DELETE request for a group member" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:delete, URI(transporter.group + '/next_group/member/lholcomb2@cnm.edu'), @headers[:other])
+      transporter.delete_member_from 'next_group', 'lholcomb2@cnm.edu'
+    end
+  end
+
+  describe "#request_export" do
+    before(:each) do
+      GoogleApps::AppsRequest.should_receive(:new).with(:post, URI(transporter.export + '/lholcomb2'), @headers[:other])
+    end
+
+    it "crafts a HTTP POST request for a mailbox export" do
+      mock_response.should_receive(:body).and_return(pending_export)
+      transporter.should_receive(:success_response?).and_return(true)
+      transporter.request_export('lholcomb2', document).should == 75133001
+    end
+
+    it "Crafts a HTTP POST request and raises an error if Google returns an error" do
+      transporter.should_receive(:success_response?).and_return(false)
+      expect { transporter.request_export('lholcomb2', document) }.to raise_error
+    end
+  end
+
+  describe "#export_status" do
+    before(:each) do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(transporter.export + '/lholcomb2/83838'), @headers[:other])
+      mock_response.stub(:body).and_return(pending_export)
+      transporter.stub(:success_response?).and_return(true)
+    end
+
+    it "crafts a HTTP GET request for a mailbox export status" do
+      transporter.export_status 'lholcomb2', 83838
+    end
+
+    it "Returns the response body from Google" do
+      transporter.export_status('lholcomb2', 83838).should be_a LibXML::XML::Document
+    end
+  end
+
+  describe "#build_id" do
+    it "Returns a query string unchanged" do
+      transporter.send(:build_id, '?bob').should == '?bob'
+    end
+
+    it "Prepends a slash to non-query strings" do
+      transporter.send(:build_id, 'tom').should == '/tom'
+    end
+  end
+
+  describe '#add_user' do
+    it "sends a POST request to the User endpoint" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:post, URI(transporter.user), @headers[:other])
+      mock_request.should_receive(:add_body).with user_doc.to_s
+      transporter.should_receive(:success_response?).and_return(true)
+      mock_response.should_receive(:body).and_return(File.read('spec/fixture_xml/user.xml'))
+
+      transporter.add_user user_doc
+    end
+  end
+
+  describe "#get_users" do
+    before(:each) do
+      mock_response.stub(:body).and_return(File.read('spec/fixture_xml/users_feed.xml'))
+      transporter.stub(:success_response?).and_return(true)
+    end
+
+    it "Builds a GET request for the user endpoint" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(transporter.user + '?startUsername=znelson1'), @headers[:other])
+      transporter.get_users start: 'znelson1', limit: 2
+    end
+
+    it "Makes another request if the response has a <link rel=\"next\" node"
+  end
+
+  describe "#download" do
+    before(:all) do
+      @url = 'http://www.google.com'
+      @filename = 'spec/download_test'
+    end
+
+    before(:each) do
+      mock_response.stub(:body).and_return("Test body")
+    end
+
+    after(:all) do
+      File.delete('spec/download_test')
+    end
+
+    it "Makes a GET request for the specified url" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(@url), @headers[:other])
+      mock_response.should_receive(:body)
+
+      transporter.download @url, @filename
+    end
+
+    it "Saves the response body to the specified filename" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(@url), @headers[:other])
+      mock_response.should_receive(:body)
+      transporter.download @url, @filename
+
+      File.read('spec/download_test').should == "Test body\n"
+    end
+  end
+
+  describe "#migrate" do
+    it "Make a POST request to the migration endpoint" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:post, URI(transporter.migration + "/#{user_name}/mail"), @headers[:migration])
+      mock_request.should_receive(:add_body).with(transporter.send(:multi_part, "bob", "cat"))
+
+      transporter.migrate(user_name, "bob", "cat")
+    end
+  end
+
+  describe "#export_ready?" do
+    before(:all) do
+      @id = 828456
+    end
+
+    it "Returns true if there is a fileUrl property in an export status doc" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(transporter.export + "/#{user_name}/#{@id}"), @headers[:other])
+      mock_response.should_receive(:body).and_return(finished_export)
+      transporter.should_receive(:success_response?).and_return(true)
+      export_status_doc = transporter.export_status(user_name, @id)
+      transporter.export_ready?(export_status_doc).should == true
+    end
+
+    it "Returns false if there is no fileUrl property in an export status doc" do
+      GoogleApps::AppsRequest.should_receive(:new).with(:get, URI(transporter.export + "/#{user_name}/#{@id}"), @headers[:other])
+      mock_response.should_receive(:body).and_return(pending_export)
+      transporter.should_receive(:success_response?).and_return(true)
+      export_status_doc = transporter.export_status(user_name, @id)
+
+      transporter.export_ready?(export_status_doc).should == false
+    end
+  end
+
+  describe "#process_response" do
+    before(:each) do
+      @mock_handler = double(GoogleApps::DocumentHandler)
+      transporter.instance_eval { @handler = @mock_handler }
+    end
+
+    it "Raises an error if Google Responds in kind" do
+      transporter.should_receive(:success_response?).and_return(false)
+      expect { transporter.get_user 'lholcomb2' }.to raise_error
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'google_apps'
+require 'webmock/rspec'
+require 'yaml'
+
+# Requires supporting ruby files with custom matchers and macros, etc,
+# in spec/support/ and its subdirectories.
+Dir[File.expand_path(File.dirname(__FILE__) + '/support/**/*.rb')].each { |f| require f }
+
+#WebMock.allow_net_connect!
+WebMock.disable_net_connect!
+
+RSpec.configure do |config|
+  #config.include FactoryGirl::Syntax::Methods
+  #config.order = "random"
+end
+

data/spec/support/helpers.rb

@@ -0,0 +1,66 @@
+def get_credentials
+  YAML.load_file(cred_file_absolute).inject({}) do |hsh, part|
+    hsh[part.flatten[0]] = part.flatten[1]
+    hsh
+  end
+end
+
+def cred_file_absolute
+  Dir.getwd + '/spec/credentials.yaml'
+end
+
+def to_meth(klasses)
+  klasses.inject([]) do |list, klass|
+    list << klass.to_s.split('::').last.scan(/[A-Z][a-z0-9]+/).map(&:downcase).join('_')
+    list
+  end
+end
+
+def basic_header
+  '<atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006" xmlns:gd="http://schemas.google.com/g/2005"/>'
+end
+
+def generate_username
+  characters = [('a'..'z'), ('A'..'Z'), (0..9)].map { |i| i.to_a }.flatten
+
+  (0..6).map { characters[rand(characters.length)] }.join
+end
+
+def get_path(category)
+  transporter.send(category.to_sym).split('/')[3..-1].join('/')
+end
+
+def build_request(verb)
+  GoogleApps::AppsRequest.new verb, 'http://www.google.com', test: 'bob'
+end
+
+def entry_node
+  entry = LibXML::XML::Node.new 'entry'
+
+  entry << LibXML::XML::Node.new('uncle')
+  entry << LibXML::XML::Node.new('aunt')
+
+  entry
+end
+
+def hash_password(password)
+  OpenSSL::Digest::SHA1.hexdigest password
+end
+
+def finished_export
+  <<-XML.strip!
+    <?xml version='1.0' encoding='UTF-8'?><entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'><id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu/lholcomb2/74876701</id><updated>2012-07-26T13:32:08.438Z</updated><link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu/lholcomb2/74876701'/><link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu/lholcomb2/74876701'/><apps:property name='numberOfFiles' value='1'/><apps:property name='packageContent' value='FULL_MESSAGE'/><apps:property name='completedDate' value='2012-07-25 19:13'/><apps:property name='status' value='COMPLETED'/><apps:property name='requestId' value='74876701'/><apps:property name='fileUrl0' value='https://apps-apis.google.com/a/data/compliance/audit/OgAAALqfKGjaeLMsuu54zP7CihO4G2eNZkXAvohVhYW4DjljfG4ltcYzUsjUY95GwfWMoS16ShFAcCr5XdxmC_skWnkAlbTyA8BJje3hRc5lIjExG-BfzzkhShNU'/><apps:property name='userEmailAddress' value='lholcomb2@cnm.edu'/><apps:property name='searchQuery' value='from: *'/><apps:property name='adminEmailAddress' value='lholcomb2@cnm.edu'/><apps:property name='requestDate' value='2012-07-25 15:56'/></entry>
+  XML
+end
+
+def pending_export
+  <<-XML.strip!
+    <?xml version='1.0' encoding='UTF-8'?><entry xmlns='http://www.w3.org/2005/Atom' xmlns:apps='http://schemas.google.com/apps/2006'><id>https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu/lholcomb2/75133001</id><updated>2012-07-26T13:37:22.497Z</updated><link rel='self' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu/lholcomb2/75133001'/><link rel='edit' type='application/atom+xml' href='https://apps-apis.google.com/a/feeds/compliance/audit/mail/export/cnm.edu/lholcomb2/75133001'/><apps:property name='packageContent' value='HEADER_ONLY'/><apps:property name='status' value='PENDING'/><apps:property name='requestId' value='75133001'/><apps:property name='userEmailAddress' value='lholcomb2@cnm.edu'/><apps:property name='searchQuery' value='from: *'/><apps:property name='adminEmailAddress' value='lholcomb2@cnm.edu'/><apps:property name='requestDate' value='2012-07-26 13:37'/></entry>
+  XML
+end
+
+def fake_nickname
+  <<-XML.strip!
+    <?xml version="1.0" encoding="UTF-8"?><atom:entry xmlns:atom="http://www.w3.org/2005/Atom" xmlns:apps="http://schemas.google.com/apps/2006">  <apps:category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/apps/2006#nickname"/>  <apps:nickname name="bobo"/></atom:entry>
+  XML
+end

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: google_apps
 version: !ruby/object:Gem::Version
-  version: '0.5'
+  version: '0.9'
   prerelease: 
 platform: ruby
 authors:
 - Glen Holcomb
+- Will Read
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-20 00:00:00.000000000 Z
+date: 2013-03-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: libxml-ruby
@@ -27,12 +28,67 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 2.2.2
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !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: webmock
+  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'
 description: Library for interfacing with Google Apps' Domain and Application APIs
 email: 
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- google_apps.gemspec
+- lib/google_apps.rb
 - lib/google_apps/apps_request.rb
 - lib/google_apps/atom/atom.rb
 - lib/google_apps/atom/document.rb
@@ -48,9 +104,30 @@ files:
 - lib/google_apps/atom/user.rb
 - lib/google_apps/document_handler.rb
 - lib/google_apps/transport.rb
-- lib/google_apps.rb
+- spec/credentials.example.yaml
+- spec/fixture_xml/mes_attr.xml
+- spec/fixture_xml/test_doc.xml
+- spec/fixture_xml/user.xml
+- spec/fixture_xml/users_feed.xml
+- spec/google_apps/apps_request_spec.rb
+- spec/google_apps/atom/document_spec.rb
+- spec/google_apps/atom/export_spec.rb
+- spec/google_apps/atom/feed_spec.rb
+- spec/google_apps/atom/group_member_spec.rb
+- spec/google_apps/atom/group_owner_spec.rb
+- spec/google_apps/atom/group_spec.rb
+- spec/google_apps/atom/message_attributes_spec.rb
+- spec/google_apps/atom/nickname_spec.rb
+- spec/google_apps/atom/node_spec.rb
+- spec/google_apps/atom/public_key_spec.rb
+- spec/google_apps/atom/user_spec.rb
+- spec/google_apps/document_handler_spec.rb
+- spec/google_apps/transport_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
 homepage: https://github.com/LeakyBucket/google_apps
-licenses: []
+licenses:
+- MIT
 post_install_message: 
 rdoc_options: []
 require_paths:
@@ -69,9 +146,30 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 1.8.25
 signing_key: 
 specification_version: 3
 summary: Google Apps APIs
-test_files: []
+test_files:
+- spec/credentials.example.yaml
+- spec/fixture_xml/mes_attr.xml
+- spec/fixture_xml/test_doc.xml
+- spec/fixture_xml/user.xml
+- spec/fixture_xml/users_feed.xml
+- spec/google_apps/apps_request_spec.rb
+- spec/google_apps/atom/document_spec.rb
+- spec/google_apps/atom/export_spec.rb
+- spec/google_apps/atom/feed_spec.rb
+- spec/google_apps/atom/group_member_spec.rb
+- spec/google_apps/atom/group_owner_spec.rb
+- spec/google_apps/atom/group_spec.rb
+- spec/google_apps/atom/message_attributes_spec.rb
+- spec/google_apps/atom/nickname_spec.rb
+- spec/google_apps/atom/node_spec.rb
+- spec/google_apps/atom/public_key_spec.rb
+- spec/google_apps/atom/user_spec.rb
+- spec/google_apps/document_handler_spec.rb
+- spec/google_apps/transport_spec.rb
+- spec/spec_helper.rb
+- spec/support/helpers.rb
 has_rdoc: