legato 0.6.2 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 4d2378f43a51af8784a18791483c114fdcfcaaff
-  data.tar.gz: e395bbd3c4bda622d04ce876454959feb1d3d9ed
+  metadata.gz: 57fdae39cb4c7cbf5275ecf85ebac7130edf5a9f
+  data.tar.gz: d0a991e8ff4c2136ffe2e4cbe0a15919d62acac4
 SHA512:
-  metadata.gz: 4f7614523c21e385d4ea0157d620c54af0b1e35643fc13ab5cf924570a5c7ba8d995a82a56859ed9ca67b82c5db7f74e0698b5f2085019792a802b2bf4c6b7dd
-  data.tar.gz: 2eb7085a97a99d5ad21471b376641beb16e9b8927af25ef4f9b1a410a1a5f3de98a247f05f1e4b00f8a6974cc5cf1e4bbde174f7b737547a2546f0426a66026d
+  metadata.gz: 97dcdeb45f4a6e56db5e6793811bb9bc3cae3760fa6f3ae5fe0aef56075c1d7a2db1b5ea92bd87571f6b60360a51185874cabd83d287623d502bf37f676f9ea8
+  data.tar.gz: 7a79a0bf57d303944b3bf32e7fe3a950d3956a4068fbeeeeb6f56f08494196645b0fa54bfe5d6060879d40109ed59186ea2f48fb02fc83fd69c7c60abb99e4a5

data/CHANGELOG.md

@@ -1,3 +1,9 @@
+## Legato 0.7.0 ##
+
+* Ensure `Filter` changes its `tracking_scope` when the query's scope is changed (by calls to `realtime`).
+
+    *Tony Pitale*
+
 ## Legato 0.6.2 ##
 
 * Add `filters` and `segment_filters` to query duplicating

data/CODE_OF_CONDUCT.md

@@ -11,12 +11,14 @@ Examples of unacceptable behavior by participants include:
 * 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.
+* 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.
+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, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
+
+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.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting a project maintainer at [INSERT EMAIL ADDRESS]. All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. Maintainers are obligated to maintain confidentiality with regard to the reporter of an incident.
 
-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/)
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.3.0, available at [http://contributor-covenant.org/version/1/3/0/](http://contributor-covenant.org/version/1/3/0/)

data/lib/legato.rb

@@ -45,6 +45,7 @@ require 'legato/request'
 require 'legato/user'
 require 'legato/profile_methods'
 
+require 'legato/management/model'
 require 'legato/management/query'
 require 'legato/management/finder'
 require 'legato/management/segment'

data/lib/legato/filter.rb

@@ -1,6 +1,6 @@
 module Legato
   class Filter
-    attr_accessor :field, :operator, :value, :join_character, :tracking_scope
+    attr_accessor :field, :operator, :value, :join_character
 
     OPERATORS = {
       # metrics
@@ -21,12 +21,17 @@ module Legato
       # :descending => '-'
     }
 
-    def initialize(field, operator, value, join_character, tracking_scope = "ga")
+    def initialize(query, field, operator, value, join_character)
+      @query = query
+
       self.field = field
       self.operator = operator
       self.value = value
       self.join_character = join_character # if nil, will be overridden by Query#apply_filter
-      self.tracking_scope = tracking_scope
+    end
+
+    def tracking_scope
+      @query.tracking_scope
     end
 
     def google_field

data/lib/legato/management/account.rb

@@ -11,15 +11,14 @@ module Legato
         "/accounts/#{id}"
       end
 
-      attr_accessor :id, :name, :user
-      attr_writer :web_properties
+      GA_ATTRIBUTES = {
+        :id => 'id',
+        :name => 'name'
+      }
 
-      def initialize(attributes, user)
-        self.user = user
+      include Model
 
-        self.id = attributes['id'] || attributes[:id]
-        self.name = attributes['name'] || attributes[:name]
-      end
+      attr_writer :web_properties
 
       def web_properties
         @web_properties ||= WebProperty.for_account(self)

data/lib/legato/management/goal.rb

@@ -12,19 +12,15 @@ module Legato
         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
+      GA_ATTRIBUTES = {
+        :id => 'id',
+        :name => 'name',
+        :account_id => 'accountId',
+        :web_property_id => 'webPropertyId',
+        :profile_id => 'profileId'
+      }
+
+      include Model
 
       def self.for_account(account)
         all(account.user, account.path+'/webproperties/~all/profiles/~all/goals')

data/lib/legato/management/model.rb

@@ -0,0 +1,26 @@
+module Legato
+  module Management
+    module Model
+
+      def self.included(model)
+        model.class_eval do
+          attr_accessor *model::GA_ATTRIBUTES.keys
+          attr_accessor :user, :attributes
+        end
+      end
+
+      def initialize(attributes, user)
+        self.user = user
+        self.attributes = attributes
+
+        build(attributes)
+      end
+
+      def build(attributes)
+        self.class::GA_ATTRIBUTES.each do |key,string_key|
+          self.send("#{key}=", attributes.delete(string_key) || attributes.delete(key))
+        end
+      end
+    end
+  end
+end

data/lib/legato/management/profile.rb

@@ -20,19 +20,9 @@ module Legato
         :web_property_id => 'webPropertyId'
       }
 
-      attr_accessor *GA_ATTRIBUTES.keys
-      attr_accessor :user, :attributes
-      attr_writer :account, :web_property
-
-      def initialize(attributes, user)
-        self.user = user
-
-        GA_ATTRIBUTES.each do |key,string_key|
-          self.send("#{key}=", attributes.delete(string_key) || attributes.delete(key))
-        end
+      include Model
 
-        self.attributes = attributes
-      end
+      attr_writer :account, :web_property
 
       def self.for_account(account)
         all(account.user, account.path+'/webproperties/~all/profiles')

data/lib/legato/management/web_property.rb

@@ -18,19 +18,9 @@ module Legato
         :website_url => 'websiteUrl'
       }
 
-      attr_accessor *GA_ATTRIBUTES.keys
-      attr_accessor :user, :attributes
-      attr_writer :account, :profiles
-
-      def initialize(attributes, user)
-        self.user = user
-
-        GA_ATTRIBUTES.each do |key,string_key|
-          self.send("#{key}=", attributes.delete(string_key) || attributes.delete(key))
-        end
+      include Model
 
-        self.attributes = attributes
-      end
+      attr_writer :account, :profiles
 
       def self.for_account(account)
         all(account.user, account.path+'/webproperties')

data/lib/legato/model.rb

@@ -33,16 +33,13 @@ module Legato
     #   parameters used for filtering the request to GA
     # @return [Proc] the body of newly defined method
     def filter(name, &block)
-      filters[name] = block
-
-      (class << self; self; end).instance_eval do
-        define_method(name) {|*args| Query.new(self).apply_filter(*args, &block)}
-      end
+      add_method_to_set(name, :filters, &block)
     end
 
     def segments
       @segments ||= {}
     end
+    alias :segment_filters :segments
 
     # Define a segment
     #
@@ -51,11 +48,7 @@ module Legato
     #   parameters used for segmenting the request to GA
     # @return [Proc] the body of newly defined method
     def segment(name, &block)
-      segments[name] = block
-
-      (class << self; self; end).instance_eval do
-        define_method(name) {|*args| Query.new(self).apply_segment_filter(*args, &block)}
-      end
+      add_method_to_set(name, :segment_filters, &block)
     end
 
     # Set the class used to make new instances of returned results from GA
@@ -96,5 +89,13 @@ module Legato
     def realtime
       Query.new(self).realtime
     end
+
+    def add_method_to_set(name, type, &block)
+      send(type)[name] = block
+
+      (class << self; self; end).instance_eval do
+        define_method(name) {|*args| Query.new(self).apply_filter_expression(type, *args, &block)}
+      end
+    end
   end
 end

data/lib/legato/query.rb

@@ -32,7 +32,7 @@ module Legato
       methods.each do |method|
         class_eval <<-CODE
           def #{method}(field, value, join_character=nil)
-            Filter.new(field, :#{method}, value, join_character)
+            Filter.new(self, field, :#{method}, value, join_character)
           end
         CODE
       end
@@ -79,6 +79,9 @@ module Legato
     end
 
     def apply_filter_expression(filter_set, *args, &block)
+      # if given :filters or :segment_filters, make a set
+      filter_set = send(filter_set) if filter_set.is_a?(Symbol)
+
       @profile = extract_profile(args)
 
       join_character = Legato.and_join_character # filters are joined by AND
@@ -233,25 +236,13 @@ module Legato
     end
 
     def to_params
-      params = {
-        'ids' => profile_id,
-        'start-date' => Legato.format_time(start_date),
-        'end-date' => Legato.format_time(end_date),
-        'max-results' => limit,
-        'start-index' => offset,
-        'segment' => segment_id || segment,
-        'filters' => filters.to_params, # defaults to AND filtering
-        'fields' => REQUEST_FIELDS,
-        'quotaUser' => quota_user,
-        'userIp' => user_ip,
-        'samplingLevel' => sampling_level
-      }
+      base_params.tap do |params|
 
-      [metrics, dimensions, sort].each do |list|
-        params.merge!(list.to_params(tracking_scope)) unless list.nil?
-      end
+        [metrics, dimensions, sort].compact.each do |list|
+          params.merge!(list.to_params(tracking_scope))
+        end
 
-      params.reject {|k,v| v.nil? || v.to_s.strip.length == 0}
+      end
     end
 
     def to_query_string
@@ -268,6 +259,22 @@ module Legato
 
     private
 
+    def base_params
+      {
+        'ids' => profile_id,
+        'start-date' => Legato.format_time(start_date),
+        'end-date' => Legato.format_time(end_date),
+        'max-results' => limit,
+        'start-index' => offset,
+        'segment' => segment_id || segment,
+        'filters' => filters.to_params, # defaults to AND filtering
+        'fields' => REQUEST_FIELDS,
+        'quotaUser' => quota_user,
+        'userIp' => user_ip,
+        'samplingLevel' => sampling_level
+      }.reject! {|_,v| v.nil? || v.to_s.strip.length == 0}
+    end
+
     def tracking_scope_valid?
       VALID_TRACKING_SCOPES.keys.include?(tracking_scope)
     end

data/lib/legato/version.rb

@@ -1,3 +1,3 @@
 module Legato
-  VERSION = "0.6.2"
+  VERSION = "0.7.0"
 end

data/spec/lib/legato/filter_spec.rb

@@ -1,9 +1,14 @@
 require 'spec_helper'
 
 describe Legato::Filter do
+  let(:klass) { Class.new.tap { |k| k.extend(Legato::Model)} }
+  let(:query) { Legato::Query.new(klass) }
+
   context "a Filter instance with mcf" do
     before :each do
-      @filter = Legato::Filter.new(:exits, :lt, 1000, nil, "mcf")
+      query.tracking_scope = 'mcf'
+
+      @filter = Legato::Filter.new(query, :exits, :lt, 1000, nil)
     end
 
     it 'represents itself as a parameter' do
@@ -11,14 +16,14 @@ describe Legato::Filter do
     end
 
     it 'joins with another filter' do
-      filter2 = Legato::Filter.new(:pageviews, :gt, 1000, ',', "mcf")
+      filter2 = Legato::Filter.new(query, :pageviews, :gt, 1000, ',')
       filter2.join_with(@filter.to_param).should == "mcf:exits<1000,mcf:pageviews>1000"
     end
   end
 
   context "a Filter instance" do
     before :each do
-      @filter = Legato::Filter.new(:exits, :lt, 1000, nil)
+      @filter = Legato::Filter.new(query, :exits, :lt, 1000, nil)
     end
 
     it 'has a field' do
@@ -52,7 +57,7 @@ describe Legato::Filter do
     end
 
     it 'joins with another filter' do
-      filter2 = Legato::Filter.new(:pageviews, :gt, 1000, ',')
+      filter2 = Legato::Filter.new(query, :pageviews, :gt, 1000, ',')
 
       filter2.join_with(@filter.to_param).should == "ga:exits<1000,ga:pageviews>1000"
     end

data/spec/lib/legato/model_spec.rb

@@ -72,14 +72,14 @@ describe "Legato::Model" do
       end
 
       it 'returns a Query instance for a filter' do
-        query = stub(:apply_filter => "a query")
+        query = stub(:apply_filter_expression => "a query")
         Legato::Query.stubs(:new).returns(query)
 
         @model.filter :high, &@block
         @model.high('arg1').should == 'a query'
 
         Legato::Query.should have_received(:new).with(@model)
-        query.should have_received(:apply_filter).with('arg1')
+        query.should have_received(:apply_filter_expression).with(:filters, 'arg1')
       end
     end
 
@@ -99,14 +99,14 @@ describe "Legato::Model" do
       end
 
       it 'returns a Query instance for a segment' do
-        query = stub(:apply_segment_filter => "a query")
+        query = stub(:apply_filter_expression => "a query")
         Legato::Query.stubs(:new).returns(query)
 
         @model.segment :high, &@block
         @model.high('arg1').should == 'a query'
 
         Legato::Query.should have_received(:new).with(@model)
-        query.should have_received(:apply_segment_filter).with('arg1')
+        query.should have_received(:apply_filter_expression).with(:segment_filters, 'arg1')
       end
     end
 

data/spec/lib/legato/query_spec.rb

@@ -10,7 +10,7 @@ describe Legato::Query do
       it "returns a new filter for #{operator} to the set" do
         Legato::Filter.stubs(:new).returns("a filter")
         filter = @query.send(operator, :key, 2000)
-        Legato::Filter.should have_received(:new).with(:key, operator, 2000, nil)
+        Legato::Filter.should have_received(:new).with(@query, :key, operator, 2000, nil)
       end
     end
   end
@@ -205,7 +205,7 @@ describe Legato::Query do
 
     context 'when applying filters' do
       before :each do
-        @filter = Legato::Filter.new(:key, :eql, 1000, nil)
+        @filter = Legato::Filter.new(query, :key, :eql, 1000, nil)
         query.stubs(:eql).returns(@filter)
 
         @filters = stub(:<<)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: legato
 version: !ruby/object:Gem::Version
-  version: 0.6.2
+  version: 0.7.0
 platform: ruby
 authors:
 - Tony Pitale
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-05 00:00:00.000000000 Z
+date: 2016-02-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake
@@ -154,6 +154,7 @@ files:
 - lib/legato/management/account_summary.rb
 - lib/legato/management/finder.rb
 - lib/legato/management/goal.rb
+- lib/legato/management/model.rb
 - lib/legato/management/profile.rb
 - lib/legato/management/query.rb
 - lib/legato/management/segment.rb