legato 0.5.1 → 0.5.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8b3ba1c16166742956642f4a56d653a1ef29979
-  data.tar.gz: d78953dc68eb6334f49d88cb283ce786702ee942
+  metadata.gz: 980eb1079898deac8afc471a03804fda0cc3865a
+  data.tar.gz: 90eb6e06d3ccfb0ebb5cb178c8e81ef9808beef6
 SHA512:
-  metadata.gz: 4932242d29976df1b52c3289377f2f686d3e9fe2d6f54f290217a8f55db956d2737b35b81457fb20a60a74554f3b00e59aad90728cafb3868e16b1b8128243da
-  data.tar.gz: 5db330c1e6397053c566adffb26c58cc145d0a536965c78a1e0b28484addbeb24c2d3396bdb4c2ad07502b5a9dab67e2cb51ca9c955b71051f9c92f871c4df1c
+  metadata.gz: bdb333f5453cb364f28a431eb1b6b84cf3c8fedd1df39a05e3af0bf6784cda44e9279b2e81051d81158daa5717cc8ed7a6ce2786deed0b59e180266acb66ef0b
+  data.tar.gz: 6596be013de3f10f9704e9ab11167316d475919038200770f34130b99dc555218905420c7cd36a000bba44db4926b054797ba3ef497ee7bda2f3b28a3d79bb1b

data/.ruby-version

@@ -1 +1 @@
-1.9.3
+2.2.2

data/.travis.yml

@@ -1,4 +1,5 @@
 language: ruby
+sudo: false
 rvm:
   - 1.9.2
   - 1.9.3

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## Legato 0.5.2 ##
+
+* Refactor `User.request` into a `Request` class
+* Implement a query class for management requests
+* Use `Request` for management with new query
+* Add `quota_user` and `user_ip` on `User` for quota management
+
+    *Tony Pitale*
+
 ## Legato 0.5.1 ##
 
 *   `Legato::User#segments`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,22 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic addresses, without explicit permission
+* Other unethical or unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

data/README.md

@@ -253,6 +253,7 @@ profile.exit.high_exits.low_pageviews
 Legato::Management::Account.all(user)
 Legato::Management::WebProperty.all(user)
 Legato::Management::Profile.all(user)
+Legato::Management::Goal.all(user)
 ```
 ## Other Parameters Can be Passed to a call to #results ##
 
@@ -286,6 +287,17 @@ query.realtime? #=> true
 query.tracking_scope #=> 'rt'
 ```
 
+## Managing Quotas ##
+
+Assigning a `quota_user` or `user_ip` on a user instance will be used by management and query requests.
+
+    ```ruby
+    user = Legato::User.new(access_token)
+    user.quota_user = 'some_unique_user_identifier'
+    # OR
+    user.user_ip = ip_address_from_a_web_user_or_something
+    ```
+
 ## License ##
 
   (The MIT License)

data/lib/legato.rb

@@ -41,12 +41,15 @@ module Legato
   end
 end
 
+require 'legato/request'
 require 'legato/user'
 require 'legato/profile_methods'
 
+require 'legato/management/query'
 require 'legato/management/finder'
 require 'legato/management/segment'
 require 'legato/management/account'
+require 'legato/management/account_summary'
 require 'legato/management/web_property'
 require 'legato/management/profile'
 require 'legato/management/goal'

data/lib/legato/management/account.rb

@@ -12,6 +12,7 @@ module Legato
       end
 
       attr_accessor :id, :name, :user
+      attr_writer :web_properties
 
       def initialize(attributes, user)
         self.user = user
@@ -21,16 +22,29 @@ module Legato
       end
 
       def web_properties
-        WebProperty.for_account(self)
+        @web_properties ||= WebProperty.for_account(self)
       end
 
       def profiles
-        Profile.for_account(self)
+        @web_properties ?
+          @web_properties.map { |property| property.profiles }.flatten :
+          Profile.for_account(self)
       end
 
       def self.from_child(child)
         all(child.user).detect {|a| a.id == child.account_id}
       end
+
+      def self.build_from_summary(attributes, user)
+        properties = attributes['webProperties'] || attributes[:webProperties]
+
+        Account.new(attributes, user).tap { |account|
+          account.web_properties = properties.map { |property|
+            property['accountId'] = account.id
+            WebProperty.build_from_summary(property, user, account)
+          }
+        }
+      end
     end
   end
 end

data/lib/legato/management/account_summary.rb

@@ -0,0 +1,32 @@
+module Legato
+  module Management
+    class AccountSummary
+      extend Finder
+
+      def self.default_path
+        "/accountSummaries"
+      end
+
+      def path
+        ""
+      end
+
+      attr_accessor :user, :account
+
+      def initialize(attributes, user)
+        self.user = user
+
+        @account = Account.build_from_summary(attributes, user)
+      end
+
+      def web_properties
+        @account.web_properties
+      end
+
+      def profiles
+        @account.profiles
+      end
+
+    end
+  end
+end

data/lib/legato/management/finder.rb

@@ -6,28 +6,15 @@ module Legato
       end
 
       def all(user, path=default_path)
-        uri = uri_for_user(user, path)
+        query = Legato::Management::Query.new(base_uri + path, self)
 
-        json = user.access_token.get(uri).body
-        items = MultiJson.decode(json).fetch('items', [])
-        items.map {|item| new(item, user)}
+        user.request(query).items.map {|item| new(item, user)}
       end
 
       def get(user, path)
-        uri = uri_for_user(user, path)
-        json = user.access_token.get(uri).body
+        query = Legato::Management::Query.new(base_uri + path, self)
 
-        new(MultiJson.decode(json), user)
-      end
-
-      def uri_for_user(user, path)
-        if user.api_key
-          # oauth + api_key
-          base_uri + path + "?key=#{user.api_key}"
-        else
-          # oauth 2
-          base_uri + path
-        end
+        new(user.request(query).data, user)
       end
     end
   end

data/lib/legato/management/profile.rb

@@ -22,6 +22,7 @@ module Legato
 
       attr_accessor *GA_ATTRIBUTES.keys
       attr_accessor :user, :attributes
+      attr_writer :account, :web_property
 
       def initialize(attributes, user)
         self.user = user
@@ -52,6 +53,13 @@ module Legato
       def goals
         Goal.for_profile(self)
       end
+
+      def self.build_from_summary(attributes, user, account, web_property)
+        Profile.new(attributes, user).tap { |profile|
+          profile.account = account
+          profile.web_property = web_property
+        }
+      end
     end
   end
 end

data/lib/legato/management/query.rb

@@ -0,0 +1,25 @@
+module Legato
+  module Management
+    class Query
+      attr_reader :instance_klass, :base_url
+
+      attr_accessor :quota_user, :user_ip
+
+      def initialize(base_url, instance_klass)
+        @base_url = base_url
+        @instance_klass = instance_klass
+      end
+
+      def to_params
+        {
+          'quotaUser' => quota_user,
+          'userIp' => user_ip
+        }.reject {|_,v| v.nil?}
+      end
+
+      def to_query_string
+        to_params.map {|k,v| [k,v].join("=")}.join("&")
+      end
+    end
+  end
+end

data/lib/legato/management/web_property.rb

@@ -20,6 +20,7 @@ module Legato
 
       attr_accessor *GA_ATTRIBUTES.keys
       attr_accessor :user, :attributes
+      attr_writer :account, :profiles
 
       def initialize(attributes, user)
         self.user = user
@@ -36,7 +37,7 @@ module Legato
       end
 
       def profiles
-        Profile.for_web_property(self)
+        @profiles ||= Profile.for_web_property(self)
       end
 
       def account
@@ -48,6 +49,19 @@ module Legato
 
         get(child.user, path)
       end
+
+      def self.build_from_summary(attributes, user, account)
+        profiles = attributes.delete('profiles') || attributes.delete(:profiles)
+
+        WebProperty.new(attributes, user).tap { |web_property|
+          web_property.account = account
+          web_property.profiles = profiles.map { |profile|
+            profile['accountId'] = account.id
+            profile['webPropertyId'] = web_property.id
+            Profile.build_from_summary(profile, user, account, web_property)
+          }
+        }
+      end
     end
   end
 end

data/lib/legato/model.rb

@@ -81,6 +81,7 @@ module Legato
     #   * offset
     #   * sort
     #   * quota_user
+    #   * segment_id
     # @return [Query] a new query with all the filters/segments defined on the
     #   model, allowing for chainable behavior before kicking of the request
     #   to Google Analytics which returns the result data

data/lib/legato/query.rb

@@ -5,6 +5,12 @@ module Legato
     MONTH = 2592000
     REQUEST_FIELDS = 'columnHeaders/name,rows,totalResults,totalsForAllResults'
 
+    VALID_TRACKING_SCOPES = {
+      'ga' => 'ga',
+      'mcf' => 'mcf',
+      'rt' => 'realtime'
+    }
+
     def define_filter(name, &block)
       (class << self; self; end).instance_eval do
         define_method(name) {|*args| apply_filter(*args, &block)}
@@ -29,7 +35,7 @@ module Legato
 
     attr_reader :parent_klass
     attr_accessor :profile, :start_date, :end_date
-    attr_accessor :sort, :limit, :offset, :quota_user, :sampling_level #, :segment # individual, overwritten
+    attr_accessor :sort, :limit, :offset, :quota_user, :user_ip, :sampling_level, :segment_id #, :segment # individual, overwritten
     attr_accessor :filters, :segment_filters # combined, can be appended to
     attr_accessor :tracking_scope
 
@@ -91,7 +97,7 @@ module Legato
     end
 
     def apply_basic_options(options)
-      [:sort, :limit, :offset, :start_date, :end_date, :quota_user, :sampling_level].each do |key| #:segment
+      [:sort, :limit, :offset, :start_date, :end_date, :quota_user, :user_ip, :sampling_level, :segment_id].each do |key| #:segment
         self.send("#{key}=".to_sym, options[key]) if options.has_key?(key)
       end
     end
@@ -189,9 +195,9 @@ module Legato
       "sessions::condition::#{segment_filters.to_params}" if segment_filters.any?
     end
 
-    # def segment_id
-    #   segment.nil? ? nil : "gaid::#{segment}"
-    # end
+    def segment_id=(segment_id)
+      @segment_id = "gaid::#{segment_id}"
+    end
 
     def profile_id
       profile && Legato.to_ga_string(profile.id)
@@ -213,10 +219,11 @@ module Legato
         'end-date' => Legato.format_time(end_date),
         'max-results' => limit,
         'start-index' => offset,
-        'segment' => segment,
+        'segment' => segment_id || segment,
         'filters' => filters.to_params, # defaults to AND filtering
         'fields' => REQUEST_FIELDS,
         'quotaUser' => quota_user,
+        'userIp' => user_ip,
         'samplingLevel' => sampling_level
       }
 
@@ -228,11 +235,23 @@ module Legato
     end
 
     def to_query_string
-      list = to_params.map {|k,v| [k,v].join("=")}
-      "?#{list.join("&")}"
+      to_params.map {|k,v| [k,v].join("=")}.join("&")
+    end
+
+    def base_url
+      raise "invalid tracking_scope" unless tracking_scope_valid?
+
+      endpoint = VALID_TRACKING_SCOPES[tracking_scope]
+
+      "https://www.googleapis.com/analytics/v3/data/#{endpoint}"
     end
 
     private
+
+    def tracking_scope_valid?
+      VALID_TRACKING_SCOPES.keys.include?(tracking_scope)
+    end
+
     def request_for_query
       profile.user.request(self)
     end

data/lib/legato/request.rb

@@ -0,0 +1,46 @@
+module Legato
+  class Request
+    attr_reader :user, :query
+
+    def initialize(user, query)
+      @user = user
+      @query = query
+    end
+
+    def response(url = nil)
+      Legato::Response.new(raw_response, query.instance_klass)
+    end
+
+    def raw_response
+      api_key? ? oauth_1_response : oauth_2_response
+    end
+
+    def api_key?
+      !user.api_key.nil?
+    end
+
+    private
+    def oauth_2_response
+      # oauth 2
+      get(query.base_url, :params => query.to_params)
+    end
+
+    def oauth_1_response
+      # oauth 1 + api key
+      get(query.base_url + query_string)
+    end
+
+    def get(*args)
+      user.access_token.get(*args)
+    end
+
+    def query_string
+      # may need to add !~@
+      [api_key_string, URI.escape(query.to_query_string, '<>')].compact.join('&')
+    end
+
+    def api_key_string
+      "?key=#{user.api_key}"
+    end
+  end
+end

data/lib/legato/response.rb

@@ -21,6 +21,14 @@ module Legato
       Hash[data["totalsForAllResults"].map{|k,v| [Legato.from_ga_string(k), number_for(v)]}]
     end
 
+    def rows
+      Array.wrap(data['rows']).compact
+    end
+
+    def items
+      Array.wrap(data['items']).compact
+    end
+
     private
     def headers
       data['columnHeaders']
@@ -30,10 +38,6 @@ module Legato
       headers.map {|header| Legato.from_ga_string(header['name'])}
     end
 
-    def rows
-      Array.wrap(data['rows']).compact
-    end
-
     def raw_attributes
       rows.map {|row| Hash[fields.zip(row)]}
     end

data/lib/legato/user.rb

@@ -1,12 +1,6 @@
 module Legato
   class User
-    attr_accessor :access_token, :api_key
-
-    VALID_TRACKING_SCOPES = {
-      'ga' => 'ga',
-      'mcf' => 'mcf',
-      'rt' => 'realtime'
-    }
+    attr_accessor :access_token, :api_key, :quota_user, :user_ip
 
     def initialize(token, api_key = nil)
       self.access_token = token
@@ -15,19 +9,9 @@ module Legato
 
     # TODO: refactor into request object again
     def request(query)
-      url = url_for(query)
-
-      raw_response = if api_key
-        # oauth 1 + api key
-        query_string = URI.escape(query.to_query_string, '<>') # may need to add !~@
-
-        access_token.get(url + query_string + "&key=#{api_key}")
-      else
-        # oauth 2
-        access_token.get(url, :params => query.to_params)
-      end
+      append_quotas_to_query(query)
 
-      Response.new(raw_response, query.instance_klass)
+      Request.new(self, query).response
     end
 
     # Management Associations
@@ -37,6 +21,10 @@ module Legato
       Management::Account.all(self)
     end
 
+    def account_summary
+      Management::AccountSummary.all(self)
+    end
+
     # All the `WebProperty` records available to this user
     def web_properties
       Management::WebProperty.all(self)
@@ -57,18 +45,10 @@ module Legato
       Management::Goal.all(self)
     end
 
-    def url_for(query)
-      raise "invalid tracking_scope" unless tracking_scope_valid?(query.tracking_scope)
-
-      endpoint = VALID_TRACKING_SCOPES[query.tracking_scope]
-
-      "https://www.googleapis.com/analytics/v3/data/#{endpoint}"
-    end
-
     private
-
-    def tracking_scope_valid?(tracking_scope)
-      VALID_TRACKING_SCOPES.keys.include?(tracking_scope)
+    def append_quotas_to_query(query)
+      query.quota_user = quota_user if quota_user
+      query.user_ip = user_ip if user_ip
     end
   end
 end

data/lib/legato/version.rb

@@ -1,3 +1,3 @@
 module Legato
-  VERSION = "0.5.1"
+  VERSION = "0.5.2"
 end

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

@@ -0,0 +1,170 @@
+require 'spec_helper'
+
+describe Legato::Management::AccountSummary do
+  let(:sample_dict) {
+    {
+      :id => 12345,
+      :kind => "analytics#accountSummary",
+      :name => "Account 1",
+      :webProperties => [
+        {
+          :kind => "analytics#webPropertySummary",
+          :id => "UA-1",
+          :name => "WebProperty1",
+          :internalWebPropertyId => 123,
+          :level => "STANDARD",
+          :websiteUrl => "http://www.google.com",
+          :profiles => [
+            {
+              :kind => "analytics#profileSummary1",
+              :id => 1234,
+              :name => "Default",
+              :type => "WEB1"
+            },
+            {
+              :kind => "analytics#profileSummary2",
+              :id => 1235,
+              :name => "Ecommerce",
+              :type => "WEB2"
+            },
+            {
+              :kind => "analytics#profileSummary3",
+              :id => 1236,
+              :name => "Testing",
+              :type => "WEB3"
+            }
+          ]
+        },
+        {
+          :kind => "analytics#webPropertySummary",
+          :id => "UA-2",
+          :name => "WebProperty2",
+          :internalWebPropertyId => 456,
+          :level => "STANDARD",
+          :websiteUrl => "http://www.google.com",
+          :profiles => [
+            {
+              :kind => "analytics#profileSummary4",
+              :id => 1237,
+              :name => "Default",
+              :type => "WEB4"
+            }
+          ]
+        }
+      ]
+    }
+  }
+
+  let(:user) { stub(:api_key => nil) }
+  let(:account_summary) { Legato::Management::AccountSummary.new(sample_dict, user) }
+
+  def self.subject_class_name
+    "account_summary"
+  end
+
+  context "The AccountSummary class" do
+    it_behaves_like "a management finder"
+
+    it 'has the correct paths' do
+      Legato::Management::AccountSummary.default_path.should == '/accountSummaries'
+      Legato::Management::AccountSummary.new(sample_dict, user).path.should == ''
+    end
+
+    it 'creates a new account summary instance from a hash of attributes' do
+      account_summary.user.should == user
+      account_summary.account.class == Legato::Management::Account
+      account_summary.web_properties.first.class == Legato::Management::WebProperty
+      account_summary.profiles.first.class == Legato::Management::Profile
+    end
+  end
+
+  context "builds proper instances" do
+    it 'builds the account instance' do
+      account_summary.account.id.should == 12345
+      account_summary.account.name.should == "Account 1"
+      account_summary.account.user.should == user
+    end
+
+    it "builds the web_properties instances" do
+      account_summary.web_properties.size.should == 2
+      account_summary.web_properties.first.attributes[:kind].should == "analytics#webPropertySummary"
+      account_summary.web_properties.first.id.should == "UA-1"
+      account_summary.web_properties.first.name.should == "WebProperty1"
+      account_summary.web_properties.first.account_id.should == 12345
+      account_summary.web_properties.first.attributes[:internalWebPropertyId].should == 123
+      account_summary.web_properties.first.attributes[:level].should == "STANDARD"
+      account_summary.web_properties.last.attributes[:kind].should == "analytics#webPropertySummary"
+      account_summary.web_properties.last.id.should == "UA-2"
+      account_summary.web_properties.last.name.should == "WebProperty2"
+      account_summary.web_properties.last.account_id.should == 12345
+      account_summary.web_properties.last.attributes[:internalWebPropertyId].should == 456
+      account_summary.web_properties.last.attributes[:level].should == "STANDARD"
+    end
+
+    it "builds the profiles" do
+      account_summary.profiles.size.should == 4
+      account_summary.profiles[0].attributes[:kind].should == "analytics#profileSummary1"
+      account_summary.profiles[0].id.should == 1234
+      account_summary.profiles[0].name.should == "Default"
+      account_summary.profiles[0].account_id.should == 12345
+      account_summary.profiles[0].web_property_id.should == "UA-1"
+      account_summary.profiles[0].attributes[:type].should == "WEB1"
+      account_summary.profiles[1].attributes[:kind].should == "analytics#profileSummary2"
+      account_summary.profiles[1].id.should == 1235
+      account_summary.profiles[1].name.should == "Ecommerce"
+      account_summary.profiles[1].account_id.should == 12345
+      account_summary.profiles[1].web_property_id.should == "UA-1"
+      account_summary.profiles[1].attributes[:type].should == "WEB2"
+      account_summary.profiles[2].attributes[:kind].should == "analytics#profileSummary3"
+      account_summary.profiles[2].id.should == 1236
+      account_summary.profiles[2].name.should == "Testing"
+      account_summary.profiles[2].account_id.should == 12345
+      account_summary.profiles[2].web_property_id.should == "UA-1"
+      account_summary.profiles[2].attributes[:type].should == "WEB3"
+      account_summary.profiles[3].attributes[:kind].should == "analytics#profileSummary4"
+      account_summary.profiles[3].id.should == 1237
+      account_summary.profiles[3].name.should == "Default"
+      account_summary.profiles[3].account_id.should == 12345
+      account_summary.profiles[3].web_property_id.should == "UA-2"
+      account_summary.profiles[3].attributes[:type].should == "WEB4"
+    end
+  end
+
+  context "allows forward and reverse traversing" do
+    it "can be used for reverse traversing to web_property from profiles" do
+      account_summary.profiles[0].web_property.should == account_summary.web_properties[0]
+      account_summary.profiles[1].web_property.should == account_summary.web_properties[0]
+      account_summary.profiles[2].web_property.should == account_summary.web_properties[0]
+      account_summary.profiles[3].web_property.should == account_summary.web_properties[1]
+    end
+
+    it "can be used for reverse traversing to account from profiles" do
+      account_summary.profiles[0].account.should == account_summary.account
+      account_summary.profiles[1].account.should == account_summary.account
+      account_summary.profiles[2].account.should == account_summary.account
+      account_summary.profiles[3].account.should == account_summary.account
+    end
+
+    it "can be used for reverse traversing to account from web_properties" do
+      account_summary.web_properties[0].account.should == account_summary.account
+      account_summary.web_properties[1].account.should == account_summary.account
+    end
+
+    it "can be used for traversing to profiles from web_properties" do
+      account_summary.web_properties[0].profiles.size.should == 3
+      account_summary.web_properties[0].profiles[0].id.should == 1234
+      account_summary.web_properties[0].profiles[1].id.should == 1235
+      account_summary.web_properties[0].profiles[2].id.should == 1236
+      account_summary.web_properties[1].profiles.size.should == 1
+      account_summary.web_properties[1].profiles[0].id.should == 1237
+    end
+
+    it "can be used for traversing to web_properties from accounts" do
+      account_summary.account.web_properties.should == account_summary.web_properties
+    end
+
+    it "can be used for traversing to profiles from accounts" do
+      account_summary.account.profiles.should == account_summary.profiles
+    end
+  end
+end

data/spec/lib/legato/query_spec.rb

@@ -323,6 +323,12 @@ describe Legato::Query do
         @query.quota_user.should == 'an id'
       end
 
+      it "sets the segment_id" do
+        segment_id = '123122534'
+        @query.apply_options({:segment_id => segment_id})
+        @query.segment_id.should == "gaid::#{segment_id}"
+      end
+
       context "with Time" do
         before :each do
           @now = Time.now
@@ -354,6 +360,28 @@ describe Legato::Query do
       end
     end
 
+    context "with the scope set" do
+      it 'raises when an invalid scope is passed in' do
+        @query.tracking_scope = "what"
+        expect { @query.base_url }.to raise_error
+      end
+
+      it 'sets the correct endpoint url' do
+        @query.tracking_scope = "mcf"
+        expect(@query.base_url).to eql("https://www.googleapis.com/analytics/v3/data/mcf")
+      end
+
+      it 'has the correct api endpoint' do
+        @query.tracking_scope = "ga"
+        expect(@query.base_url).to eql("https://www.googleapis.com/analytics/v3/data/ga")
+      end
+
+      it 'has the realtime api endpoint' do
+        @query.tracking_scope = "rt"
+        expect(@query.base_url).to eql("https://www.googleapis.com/analytics/v3/data/realtime")
+      end
+    end
+
     it_defines_operators :eql, :not_eql, :gt, :gte, :lt, :lte, :matches,
       :does_not_match, :contains, :does_not_contain, :substring, :not_substring
 
@@ -439,6 +467,20 @@ describe Legato::Query do
         @query.to_params['segment'].should == 'sessions::condition::ga::parameter'
       end
 
+      it 'includes segment_id' do
+        @query.stubs(:segment_id).returns('gaid::12453453')
+
+        @query.to_params['segment'].should == 'gaid::12453453'
+      end
+
+      it 'includes segment_id and segment_filters' do
+        segment_filters = stub(:to_params => 'ga::parameter', :any? => true)
+        @query.stubs(:segment_filters).returns(segment_filters)
+        @query.stubs(:segment_id).returns('gaid::12453453')
+
+        @query.to_params['segment'].should == 'gaid::12453453'
+      end
+
       it 'includes metrics' do
         metrics = Legato::ListParameter.new(:metrics)
         metrics.stubs(:to_params).returns({'metrics' => 'pageviews,exits'})

data/spec/lib/legato/user_spec.rb

@@ -1,76 +1,75 @@
 require 'spec_helper'
 
 describe Legato::User do
-  context "an instance of Legato::User with the scope set" do
-    let(:user) {user = Legato::User.new(@access_token, nil)}
+  context "an instance of Legato::User" do
+    let(:instance_klass) { Class.new }
+    let(:klass) { Class.new.tap {|k| k.extend(Legato::Model)} }
+    let(:query) { Legato::Query.new(klass) }
+    let(:access_token) { stub }
+    let(:user) { Legato::User.new(access_token) }
 
-    before :each do
-      @access_token = stub
+    before(:each) do
+      query.stubs(:instance_klass).returns(instance_klass)
     end
 
-    it 'raises when an invalid scope is passed in' do
-      expect { user.url_for(stub(:tracking_scope => "what"))}.to raise_error
-    end
+    it 'assigns a quota user to the query' do
+      Legato::Request.stubs(:new).returns(stub(:response => 'response'))
 
-    it 'sets the correct endpoint url' do
-      user.url_for(stub(:tracking_scope => 'mcf')).should == "https://www.googleapis.com/analytics/v3/data/mcf"
-    end
-  end
+      user.quota_user = 'user12345678'
+      user.request(query)
 
-  context "an instance of Legato::User" do
-    before :each do
-      @access_token = stub
-      @user = Legato::User.new(@access_token)
+      expect(query.to_params['quotaUser']).to eql('user12345678')
     end
 
-    it 'has the correct api endpoint' do
-      @user.url_for(stub(:tracking_scope => 'ga')).should == "https://www.googleapis.com/analytics/v3/data/ga"
-    end
+    it 'assigns a user ip to the query' do
+      Legato::Request.stubs(:new).returns(stub(:response => 'response'))
+
+      user.user_ip = '127.0.0.1'
+      user.request(query)
 
-    it 'has the realtime api endpoint' do
-      @user.url_for(stub(:tracking_scope => 'rt')).should == "https://www.googleapis.com/analytics/v3/data/realtime"
+      expect(query.to_params['userIp']).to eql('127.0.0.1')
     end
 
     it 'returns a response for a given query' do
-      klass = Class.new
-      @access_token.stubs(:get).returns('a response')
+      query.stubs(:to_params).returns('params')
+      access_token.stubs(:get).returns('a response')
       Legato::Response.stubs(:new)
-      @user.stubs(:url_for).returns("the_api_url")
+      query.stubs(:base_url).returns("the_api_url")
 
-      @user.request(stub(:to_params => "params", :instance_klass => klass))
+      user.request(query)
 
-      Legato::Response.should have_received(:new).with('a response', klass)
-      @access_token.should have_received(:get).with("the_api_url", :params => "params")
+      Legato::Response.should have_received(:new).with('a response', instance_klass)
+      access_token.should have_received(:get).with("the_api_url", :params => "params")
     end
 
     it 'has accounts' do
       Legato::Management::Account.stubs(:all)
-      @user.accounts
-      Legato::Management::Account.should have_received(:all).with(@user)
+      user.accounts
+      Legato::Management::Account.should have_received(:all).with(user)
     end
 
     it 'has web_properties' do
       Legato::Management::WebProperty.stubs(:all)
-      @user.web_properties
-      Legato::Management::WebProperty.should have_received(:all).with(@user)
+      user.web_properties
+      Legato::Management::WebProperty.should have_received(:all).with(user)
     end
 
     it 'has profiles' do
       Legato::Management::Profile.stubs(:all)
-      @user.profiles
-      Legato::Management::Profile.should have_received(:all).with(@user)
+      user.profiles
+      Legato::Management::Profile.should have_received(:all).with(user)
     end
 
     it 'has segments' do
       Legato::Management::Segment.stubs(:all)
-      @user.segments
-      Legato::Management::Segment.should have_received(:all).with(@user)
+      user.segments
+      Legato::Management::Segment.should have_received(:all).with(user)
     end
 
     it 'has goals' do
       Legato::Management::Goal.stubs(:all)
-      @user.goals
-      Legato::Management::Goal.should have_received(:all).with(@user)
+      user.goals
+      Legato::Management::Goal.should have_received(:all).with(user)
     end
   end
 end

data/spec/support/examples/management_finder.rb

@@ -1,16 +1,9 @@
 shared_examples_for "a management finder" do
   let(:response) { stub(:body => 'some json') }
   let(:access_token) { stub(:get => response) }
-  let(:user) { stub(:access_token => access_token, :api_key => nil) }
+  let(:user) { Legato::User.new(access_token, nil) }
 
   context ".all" do
-    after do
-      user.should have_received(:access_token)
-      access_token.should have_received(:get).with('https://www.googleapis.com/analytics/v3/management'+described_class.default_path)
-      response.should have_received(:body)
-      MultiJson.should have_received(:decode).with('some json')
-    end
-
     it "returns an array of all #{subject_class_name} available to a user" do
       MultiJson.stubs(:decode).returns({'items' => ['item1', 'item2']})
       described_class.stubs(:new).returns('thing1', 'thing2')
@@ -19,6 +12,10 @@ shared_examples_for "a management finder" do
 
       described_class.should have_received(:new).with('item1', user)
       described_class.should have_received(:new).with('item2', user)
+
+      access_token.should have_received(:get).with('https://www.googleapis.com/analytics/v3/management'+described_class.default_path, :params => {})
+      response.should have_received(:body)
+      MultiJson.should have_received(:decode).with('some json')
     end
 
     it "returns an empty array of #{subject_class_name} when there are no results" do
@@ -30,13 +27,6 @@ shared_examples_for "a management finder" do
   end
 
   context ".get" do
-    after do
-      user.should have_received(:access_token)
-      access_token.should have_received(:get).with('https://www.googleapis.com/analytics/v3/management/path')
-      response.should have_received(:body)
-      MultiJson.should have_received(:decode).with('some json')
-    end
-
     it "returns an instance of #{subject_class_name} for a given path" do
       MultiJson.stubs(:decode).returns('attributes')
       described_class.stubs(:new).returns('thing')
@@ -45,6 +35,10 @@ shared_examples_for "a management finder" do
 
       expect(described_class.get(user, path)).to eq('thing')
       expect(described_class).to have_received(:new).with('attributes', user)
+
+      access_token.should have_received(:get).with('https://www.googleapis.com/analytics/v3/management/path', :params => {})
+      response.should have_received(:body)
+      MultiJson.should have_received(:decode).with('some json')
     end
   end
-end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: legato
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.5.2
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-11 00:00:00.000000000 Z
+date: 2015-09-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -137,6 +137,7 @@ files:
 - ".ruby-version"
 - ".travis.yml"
 - CHANGELOG.md
+- CODE_OF_CONDUCT.md
 - Gemfile
 - README.md
 - Rakefile
@@ -150,14 +151,17 @@ files:
 - lib/legato/filter_set.rb
 - lib/legato/list_parameter.rb
 - lib/legato/management/account.rb
+- lib/legato/management/account_summary.rb
 - lib/legato/management/finder.rb
 - lib/legato/management/goal.rb
 - lib/legato/management/profile.rb
+- lib/legato/management/query.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/request.rb
 - lib/legato/response.rb
 - lib/legato/user.rb
 - lib/legato/version.rb
@@ -173,6 +177,7 @@ files:
 - spec/lib/legato/legato_spec.rb
 - spec/lib/legato/list_parameter_spec.rb
 - spec/lib/legato/management/account_spec.rb
+- spec/lib/legato/management/account_summary_spec.rb
 - spec/lib/legato/management/goal_spec.rb
 - spec/lib/legato/management/legato_spec.rb
 - spec/lib/legato/management/profile_spec.rb
@@ -221,6 +226,7 @@ test_files:
 - spec/lib/legato/legato_spec.rb
 - spec/lib/legato/list_parameter_spec.rb
 - spec/lib/legato/management/account_spec.rb
+- spec/lib/legato/management/account_summary_spec.rb
 - spec/lib/legato/management/goal_spec.rb
 - spec/lib/legato/management/legato_spec.rb
 - spec/lib/legato/management/profile_spec.rb