legato 0.2.0 → 0.3.0

data/CHANGELOG.md

@@ -1,3 +1,15 @@
+## Legato 0.3.0 ##
+
+*   Adds Management Goal under Profile
+*   Adds Management Segment
+*   Adds all `attributes` to WebProperty
+*   Adds `legato` CLI
+
+      Loads OAuth2 configuration and a legato user before dropping you into an
+      `irb` session.
+
+    *Tony Pitale*
+
 ## Legato 0.2.0 ##
 
 *   Changed Query API for #metrics & #dimensions

data/bin/legato

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+
+require 'legato'
+require 'legato/cli'
+
+cli = Legato::CLI.new
+
+@legato_user = cli.build_user
+
+def legato_user
+  @legato_user
+end
+
+include Legato::Management
+
+cli.run

data/legato.gemspec

@@ -27,7 +27,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency "bourne"
   s.add_development_dependency "vcr", "2.0.0.beta2"
   s.add_development_dependency "fakeweb"
-  s.add_development_dependency "oauth2"
   s.add_development_dependency "simplecov"
 
   s.add_runtime_dependency "multi_json"

data/lib/legato.rb

@@ -41,9 +41,11 @@ require 'legato/user'
 require 'legato/profile_methods'
 
 require 'legato/management/finder'
+require 'legato/management/segment'
 require 'legato/management/account'
 require 'legato/management/web_property'
 require 'legato/management/profile'
+require 'legato/management/goal'
 
 require 'legato/list_parameter'
 require 'legato/response'

data/lib/legato/cli.rb

@@ -0,0 +1,110 @@
+require 'irb'
+require 'yaml'
+require 'oauth2'
+
+module Legato
+
+  module OAuth2Helpers
+    def build_client(id, secret)
+      opts = {
+        :authorize_url => 'https://accounts.google.com/o/oauth2/auth',
+        :token_url => 'https://accounts.google.com/o/oauth2/token'
+      }
+
+      OAuth2::Client.new(id, secret, opts)
+    end
+
+    def auth_url(client)
+      client.auth_code.authorize_url({
+        :scope => 'https://www.googleapis.com/auth/analytics.readonly',
+        :redirect_uri => 'http://localhost'
+      })
+    end
+
+    extend self
+  end
+
+  class CLI
+    def initialize
+      path = File.join(ENV['HOME'], '.legato.yml')
+
+      if File.exists?(path)
+        @config = YAML.load_file(path) rescue {}
+      else
+        puts "##########################################################"
+        puts "We can auto-load OAuth2 config from ~/.legato.yml"
+        puts "##########################################################"
+
+        build_config
+      end
+
+      build_access_token
+
+      print_yaml
+    end
+
+    def run
+      setup_irb
+    end
+
+    def setup_irb
+      IRB.setup(nil)
+      irb = IRB::Irb.new
+      IRB.conf[:MAIN_CONTEXT] = irb.context
+      irb.context.evaluate("require 'irb/completion'", 0)
+
+      trap("SIGINT") do
+        irb.signal_handle
+      end
+      catch(:IRB_EXIT) do
+        irb.eval_input
+      end
+    end
+
+    def client
+      @client ||= OAuth2Helpers.build_client(@config['id'], @config['secret'])
+    end
+
+    def token
+      @config['token']
+    end
+
+    def build_config
+      @config ||= {}
+
+      puts
+      print 'Your OAuth2 id: '
+      @config['id'] = $stdin.gets.strip
+      print 'Your OAuth2 secret: '
+      @config['secret'] = $stdin.gets.strip
+    end
+
+    def build_access_token
+      if token
+        @access_token = OAuth2::AccessToken.new(client, token)
+      else
+        puts
+        puts "Opening the OAuth2 auth url: #{OAuth2Helpers.auth_url(client)} ..."
+        `open "#{OAuth2Helpers.auth_url(client)}"`
+
+        puts
+        print 'OAuth2 Code (in the url): '
+        code = $stdin.gets.strip
+
+        @access_token = client.auth_code.get_token(code, :redirect_uri => 'http://localhost')
+        @config['token'] = @access_token.token
+      end
+    end
+
+    def build_user
+      Legato::User.new(@access_token)
+    end
+
+    def print_yaml
+      puts "##########################################################"
+      puts "If you haven't already done so, you can make ~/.legato.yml"
+      puts YAML.dump(@config)
+      puts "##########################################################"
+    end
+  end
+end

data/lib/legato/management/goal.rb

@@ -0,0 +1,42 @@
+module Legato
+  module Management
+    class Goal
+
+      extend Finder
+
+      def self.default_path
+        "/accounts/~all/webproperties/~all/profiles/~all/goals"
+      end
+
+      def path
+        self.class.default_path + "/" + id.to_s
+      end
+
+      attr_accessor :id, :name, :account_id, :web_property_id, :profile_id, :user, :attributes
+
+      def initialize(attributes, user)
+        self.user = user
+        self.id = attributes['id']
+        self.name = attributes['name']
+        self.account_id = attributes['accountId']
+        self.web_property_id = attributes['webPropertyId']
+        self.profile_id = attributes['profileId']
+
+        ['id', 'name', 'accountId', 'webPropertyId', 'profileId'].each { |key| attributes.delete(key) }
+        self.attributes = attributes
+      end
+
+      def self.for_account(account)
+        all(account.user, account.path+'/webproperties/~all/profiles/~all/goals')
+      end
+
+      def self.for_web_property(web_property)
+        all(web_property.user, web_property.path+'/profiles/~all/goals')
+      end
+
+      def self.for_profile(profile)
+        all(profile.user, profile.path+'/goals')
+      end
+    end
+  end
+end

data/lib/legato/management/profile.rb

@@ -10,18 +10,19 @@ module Legato
       end
 
       def path
-        self.class.default_path + "/" + id.to_s
+        "/accounts/#{account_id}/webproperties/#{web_property_id}/profiles/#{id}"
       end
 
-      attr_accessor :id, :name, :web_property_id, :user, :attributes
+      attr_accessor :id, :name, :web_property_id, :account_id, :user, :attributes
 
       def initialize(attributes, user)
         self.user = user
         self.id = attributes['id']
         self.name = attributes['name']
+        self.account_id = attributes['accountId']
         self.web_property_id = attributes['webPropertyId']
 
-        ['id', 'name', 'webPropertyId'].each { |key| attributes.delete(key) }
+        ['id', 'name', 'accountId', 'webPropertyId'].each { |key| attributes.delete(key) }
         self.attributes = attributes
       end
 
@@ -32,6 +33,10 @@ module Legato
       def self.for_web_property(web_property)
         all(web_property.user, web_property.path+'/profiles')
       end
+
+      def goals
+        Goal.for_profile(self)
+      end
     end
   end
 end

data/lib/legato/management/segment.rb

@@ -0,0 +1,24 @@
+module Legato
+  module Management
+    class Segment
+      extend Finder
+
+      def self.default_path
+        "/segments"
+      end
+
+      def path
+        "/segments/#{id}"
+      end
+
+      attr_accessor :id, :name, :definition, :user
+
+      def initialize(attributes, user)
+        self.user = user
+        self.id = attributes['id']
+        self.name = attributes['name']
+        self.definition = attributes['definition']
+      end
+    end
+  end
+end

data/lib/legato/management/web_property.rb

@@ -8,16 +8,18 @@ module Legato
       end
 
       def path
-        self.class.default_path + "/" + id.to_s
+        "/accounts/#{account_id}/webproperties/#{id}"
       end
 
-      attr_accessor :id, :name, :website_url, :user
+      attr_accessor :id, :name, :website_url, :account_id, :user, :attributes
 
       def initialize(attributes, user)
         self.user = user
         self.id = attributes['id']
-        self.name = attributes['name']
-        self.website_url = attributes['websiteUrl']
+        self.name = attributes.delete('name')
+        self.website_url = attributes.delete('websiteUrl')
+        self.account_id = attributes.delete('accountId')
+        self.attributes = attributes
       end
 
       def self.for_account(account)

data/lib/legato/version.rb

@@ -1,3 +1,3 @@
 module Legato
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

data/spec/lib/legato/management/goal_spec.rb

@@ -0,0 +1,58 @@
+require 'spec_helper'
+
+describe Legato::Management::Goal do
+  context "The Goal class" do
+    def self.subject_class_name
+      "goals"
+    end
+
+    it_behaves_like "a management finder"
+
+    it 'creates a new goal instance from a hash of attributes' do
+      user = stub
+      goal = Legato::Management::Goal.new({"id" => 12345, "name" => "Goal 1", "webPropertyId" => "WebProperty 7", "profileId" => "Profile 111", "value" => "/blah"}, user)
+      goal.user.should == user
+      goal.id.should == 12345
+      goal.name.should == "Goal 1"
+      goal.web_property_id.should == "WebProperty 7"
+      goal.profile_id.should == "Profile 111"
+
+      goal.attributes["value"].should == "/blah"
+      goal.attributes.has_key?("id").should be_false
+    end
+
+    it 'returns an array of all goals available to a user under an account' do
+      account = stub(:user => 'user', :path => 'accounts/12345')
+      Legato::Management::Goal.stubs(:all)
+
+      Legato::Management::Goal.for_account(account)
+
+      Legato::Management::Goal.should have_received(:all).with('user', 'accounts/12345/webproperties/~all/profiles/~all/goals')
+    end
+
+    it 'returns an array of all goals available to a user under an web property' do
+      web_property = stub(:user => 'user', :path => 'accounts/~all/webproperties/12345')
+      Legato::Management::Goal.stubs(:all)
+
+      Legato::Management::Goal.for_web_property(web_property)
+
+      Legato::Management::Goal.should have_received(:all).with('user', 'accounts/~all/webproperties/12345/profiles/~all/goals')
+    end
+
+    it 'returns an array of all goals available to a user under a profile' do
+      profile = stub(:user => 'user', :path => 'accounts/~all/webproperties/~all/profiles/12345')
+      Legato::Management::Goal.stubs(:all)
+
+      Legato::Management::Goal.for_profile(profile)
+
+      Legato::Management::Goal.should have_received(:all).with('user', 'accounts/~all/webproperties/~all/profiles/12345/goals')
+    end
+  end
+
+  context "A Goal instance" do
+    it 'builds the path for the goal from the id' do
+      goal = Legato::Management::Goal.new({"id" => 12345}, stub)
+      goal.path.should == '/accounts/~all/webproperties/~all/profiles/~all/goals/12345'
+    end
+  end
+end

data/spec/lib/legato/management/profile_spec.rb

@@ -10,11 +10,12 @@ describe Legato::Management::Profile do
 
     it 'creates a new profile instance from a hash of attributes' do
       user = stub
-      profile = Legato::Management::Profile.new({"id" => 12345, "name" => "Profile 1", "webPropertyId" => "WebProperty 7", "timezone" => "America/Edmonton"}, user)
+      profile = Legato::Management::Profile.new({"id" => 12345, "name" => "Profile 1", "accountId" => "12345", "webPropertyId" => "UA-12345-2", "timezone" => "America/Edmonton"}, user)
       profile.user.should == user
       profile.id.should == 12345
       profile.name.should == "Profile 1"
-      profile.web_property_id.should == "WebProperty 7"
+      profile.account_id.should == "12345"
+      profile.web_property_id.should == "UA-12345-2"
 
       profile.attributes["timezone"].should == "America/Edmonton"
       profile.attributes.has_key?("id").should be_false
@@ -30,19 +31,19 @@ describe Legato::Management::Profile do
     end
 
     it 'returns an array of all profiles available to a user under an web property' do
-      web_property = stub(:user => 'user', :path => 'accounts/~all/webproperties/12345')
+      web_property = stub(:user => 'user', :path => 'accounts/12345/webproperties/UA-12345-3')
       Legato::Management::Profile.stubs(:all)
 
       Legato::Management::Profile.for_web_property(web_property)
 
-      Legato::Management::Profile.should have_received(:all).with('user', 'accounts/~all/webproperties/12345/profiles')
+      Legato::Management::Profile.should have_received(:all).with('user', 'accounts/12345/webproperties/UA-12345-3/profiles')
     end
   end
 
   context "A Profile instance" do
     it 'builds the path for the profile from the id' do
-      web_property = Legato::Management::Profile.new({"id" => 12345}, stub)
-      web_property.path.should == '/accounts/~all/webproperties/~all/profiles/12345'
+      profile = Legato::Management::Profile.new({"id" => 45678, "accountId" => "12345", "webPropertyId" => "UA-12345-3"}, stub)
+      profile.path.should == '/accounts/12345/webproperties/UA-12345-3/profiles/45678'
     end
   end
 end

data/spec/lib/legato/management/segment_spec.rb

@@ -0,0 +1,20 @@
+require 'spec_helper'
+
+describe Legato::Management::Segment do
+  context "The Segment class" do
+    def self.subject_class_name
+      "segments"
+    end
+
+    it_behaves_like "a management finder"
+
+    it 'creates a new segment instance from a hash of attributes' do
+      user = stub(:api_key => nil)
+      segment = Legato::Management::Segment.new({"id" => 12345, "name" => "Segment 1", "definition" => "Some Segment"}, user)
+      segment.user.should == user
+      segment.id.should == 12345
+      segment.name.should == "Segment 1"
+      segment.definition.should == "Some Segment"
+    end
+  end
+end

data/spec/lib/legato/management/web_property_spec.rb

@@ -10,11 +10,22 @@ describe Legato::Management::WebProperty do
 
     it 'creates a new web property instance from a hash of attributes' do
       user = stub
-      web_property = Legato::Management::WebProperty.new({"id" => 12345, "name" => "WebProperty 1", "websiteUrl" => "http://google.com"}, user)
+      web_property = Legato::Management::WebProperty.new({
+        "id" => "UA-123456-2",
+        "name" => "WebProperty 1",
+        "websiteUrl" => "http://google.com",
+        "accountId" => "123456",
+        "profileCount" => 8,
+        "industryVertical" => "ecommerce"
+      }, user)
+
       web_property.user.should == user
-      web_property.id.should == 12345
+      web_property.id.should == "UA-123456-2"
       web_property.name.should == "WebProperty 1"
       web_property.website_url.should == 'http://google.com'
+      web_property.account_id.should == "123456"
+      web_property.attributes['profileCount'].should == 8
+      web_property.attributes['industryVertical'].should == "ecommerce"
     end
 
     it 'returns an array of all web properties available to a user under an account' do
@@ -27,8 +38,8 @@ describe Legato::Management::WebProperty do
 
   context "A WebProperty instance" do
     it 'builds the path for the web_property from the id' do
-      web_property = Legato::Management::WebProperty.new({"id" => 123456}, stub)
-      web_property.path.should == '/accounts/~all/webproperties/123456'
+      web_property = Legato::Management::WebProperty.new({"id" => "UA-123456-5", "accountId" => "123456"}, stub)
+      web_property.path.should == '/accounts/123456/webproperties/UA-123456-5'
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: legato
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-25 00:00:00.000000000 Z
+date: 2014-01-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -107,22 +107,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: oauth2
-  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: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -160,7 +144,8 @@ description: Access the Google Analytics Core Reporting and Management APIs with
   need.
 email:
 - tpitale@gmail.com
-executables: []
+executables:
+- legato
 extensions: []
 extra_rdoc_files: []
 files:
@@ -172,9 +157,10 @@ files:
 - Gemfile
 - README.md
 - Rakefile
+- bin/legato
 - legato.gemspec
 - lib/legato.rb
-- lib/legato/collection.rb
+- lib/legato/cli.rb
 - lib/legato/core_ext/array.rb
 - lib/legato/core_ext/string.rb
 - lib/legato/filter.rb
@@ -182,15 +168,14 @@ files:
 - lib/legato/list_parameter.rb
 - lib/legato/management/account.rb
 - lib/legato/management/finder.rb
+- lib/legato/management/goal.rb
 - lib/legato/management/profile.rb
+- lib/legato/management/segment.rb
 - lib/legato/management/web_property.rb
 - lib/legato/model.rb
 - lib/legato/profile_methods.rb
 - lib/legato/query.rb
-- lib/legato/reports.rb
-- lib/legato/request.rb
 - lib/legato/response.rb
-- lib/legato/result_set.rb
 - lib/legato/user.rb
 - lib/legato/version.rb
 - spec/cassettes/management/accounts.json
@@ -204,7 +189,9 @@ files:
 - spec/lib/legato/filter_spec.rb
 - spec/lib/legato/list_parameter_spec.rb
 - spec/lib/legato/management/account_spec.rb
+- spec/lib/legato/management/goal_spec.rb
 - spec/lib/legato/management/profile_spec.rb
+- spec/lib/legato/management/segment_spec.rb
 - spec/lib/legato/management/web_property_spec.rb
 - spec/lib/legato/model_spec.rb
 - spec/lib/legato/query_spec.rb
@@ -249,7 +236,9 @@ test_files:
 - spec/lib/legato/filter_spec.rb
 - spec/lib/legato/list_parameter_spec.rb
 - spec/lib/legato/management/account_spec.rb
+- spec/lib/legato/management/goal_spec.rb
 - spec/lib/legato/management/profile_spec.rb
+- spec/lib/legato/management/segment_spec.rb
 - spec/lib/legato/management/web_property_spec.rb
 - spec/lib/legato/model_spec.rb
 - spec/lib/legato/query_spec.rb
@@ -258,3 +247,4 @@ test_files:
 - spec/spec_helper.rb
 - spec/support/examples/management_finder.rb
 - spec/support/macros/oauth.rb
+has_rdoc: 

data/lib/legato/collection.rb

@@ -1,5 +0,0 @@
-module Legato
-	class Collection
-		
-	end
-end

data/lib/legato/reports.rb

@@ -1,16 +0,0 @@
-# module Legato
-#   module Reports
-#     def self.add_report_method(klass)
-#       # demodulize leaves potential to redefine
-#       # these methods given different namespaces
-#       method_name = klass.name.to_s.demodulize.underscore
-#       return unless method_name.length > 0
-# 
-#       class_eval <<-CODE
-#         def #{method_name}(opts = {}, &block)
-#           #{klass}.results(self, opts, &block)
-#         end
-#       CODE
-#     end
-#   end
-# end

data/lib/legato/request.rb

@@ -1,21 +0,0 @@
-# module Legato
-#   class Request
-#     URL = "https://www.googleapis.com/analytics/v3/data/ga"
-# 
-#     def initialize(query)
-#       @query = query
-#     end
-# 
-#     def response
-#       @response ||= Response.new(parsed_response)
-#     end
-# 
-#     def parsed_response
-#       MultiJson.decode(raw_response)
-#     end
-# 
-#     def raw_response
-#       @query.profile.user.get(URL, :params => @query.to_params)
-#     end
-#   end
-# end

data/lib/legato/result_set.rb

@@ -1,21 +0,0 @@
-# module Legato
-#   class ResultSet
-#     include Enumerable
-# 
-#     attr_accessor :total_results, :sampled
-# 
-#     alias :sampled? :sampled
-# 
-#     def initialize(results)
-#       @results = results
-#     end
-# 
-#     def each(&block)
-#       @results.each(&block)
-#     end
-# 
-#     def to_a
-#       @results
-#     end
-#   end
-# end