pirsch_api 0.0.3 → 0.0.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b41470047653a8abd5e3eff60fe44bef1d2afb51c82279ef48879be999fc8243
-  data.tar.gz: fdb4e7546d50d6049f48e727781ecb2e9395b105e4149aa01e83070340c97c43
+  metadata.gz: 922968a144011f70f78f0e8220f5de11dd2c2abd4ed710a1d82ac9ebfe8b581d
+  data.tar.gz: b296b02a35e78d2997903099c22fab51154775c2930f37875e838909cd52b37f
 SHA512:
-  metadata.gz: 9b4aa5375433d5a9196928eecddbf7d8edfcaa39161853dd84cfe51e1bf9e9bfa71e733755982ecd1014c87a52d995e34acc327911f45ce0d1fd7ea59a0e1979
-  data.tar.gz: 2d0763db86bbaeb91027bbdad1ef3baacb01fe8ebf91e6e80051026e8700a74f44c54b9684c5e3e62c1ee7830e1b0e960645f63d5e100885e67bcda9995768b1
+  metadata.gz: c13b95de3a1dfe8737e7676b91f0762a88975aed761fdb7540f89d349822eb069e7f4b6859bb45b770abd18701b601c7ee2a4b3ac96b80305a796085e3f04312
+  data.tar.gz: f0ee7dcc857538c1fb7023660e9dd55587e27ba4c1238559586184cece0a525598adaca8ce77deb760fdb8a42a85ca87c4ca94afcdab4a9f6ae7a352cc68a406

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    pirsch_api (0.0.3)
+    pirsch_api (0.0.4)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -20,67 +20,69 @@ client.valid?
 ```
 
 You will need a `Domain` as a parameter to all the following methods. This parameter could be either
-a `PisrchApi::Domain` instance or a simple String containing the `id` of one domain.
+a `PirschApi::Domain` instance or a simple String containing the `id` of one domain.
 
 ```rb
 # Get /domains
 client.domains
 => [#<PirschApi::Domain id="0D3a...", user_id="0D3a...", hostname="pirsch.io", subdomain="pirsch", ... >]
-domain = c.domains.first
-domain.hostname
-=> "pirsch.io"
-domain.id
-=> "0D3a..."
-domain.to_s
-=> "0D3a..."
+domain = client.domains.first
 ```
+
 All the following methods receive a `domain` and an optional `filters` hash as a parameter. You can include any filter defined in the official documentation.
 
 ```rb
 # Get /statistics/visitors
-client.visitors(domain: domain)
+client.visitors(domain: domain, filters: filters)
 
 # Get /statistics/active
-client.active(domain: domain)
+client.active(domain: domain, filters: filters)
 
 # Get /statistics/pages
-client.pages(domain: domain)
+client.pages(domain: domain, filters: filters)
 
 # Get /statistics/referrers
-client.referrers(domain: domain)
+client.referrers(domain: domain, filters: filters)
 
 # Get /statistics/growth
-client.growth(domain: domain)
+client.growth(domain: domain, filters: filters)
 
 # Get /statistics/events
-client.events(domain: domain)
+client.events(domain: domain, filters: filters)
 
 # Get /statistics/utm/source
-client.utm_source(domain: domain)
+client.utm_source(domain: domain, filters: filters)
 
 # Get /statistics/utm/medium
-client.utm_medium(domain: domain)
+client.utm_medium(domain: domain, filters: filters)
 
 # Get /statistics/utm/campaign
-client.utm_campaign(domain: domain)
+client.utm_campaign(domain: domain, filters: filters)
+
+# Get /statistics/duration/session
+client.duration_session(domain: domain, filters: filters)
+
+# Get /statistics/duration/page
+client.duration_page(domain: domain, filters: filters)
+
 ```
 
 ## Examples
 ```rb
-
-client.visitors(domain: d)
+client.visitors(domain: domain)
 => [#<PirschApi::Visitor day="2021-08-30T00:00:00Z", visitors=87, views=200, sessions=125, bounces=53, bounce_rate=0.6091954022988506>, #<PirschApi::Visitor day="2021-08-31T00:00:00Z", visitors=77, views=159, sessions=113, bounces=49, bounce_rate=0.6363636363636364>, #<PirschApi::Visitor day="2021-09-01T00:00:00Z", visitors=76, views=161, sessions=110, bounces=48, bounce_rate=0.631578947368421>, #<PirschApi::Visitor day="2021-09-02T00:00:00Z", visitors=79, views=152, sessions=130, bounces=52, bounce_rate=0.6582278481012658>, #<PirschApi::Visitor day="2021-09-03T00:00:00Z", visitors=53, views=109, sessions=68, bounces=26, bounce_rate=0.49056603773584906>, #<PirschApi::Visitor day="2021-09-04T00:00:00Z", visitors=54, views=126, sessions=71, bounces=31, bounce_rate=0.5740740740740741>, #<PirschApi::Visitor day="2021-09-05T00:00:00Z", visitors=116, views=202, sessions=131, bounces=84, bounce_rate=0.7241379310344828>, #<PirschApi::Visitor day="2021-09-06T00:00:00Z", visitors=1, views=1, sessions=1, bounces=1, bounce_rate=1>]
 
-client.visitors(domain: d, filters: { from: '2021-09-01' })
+client.visitors(domain: domain, filters: { from: '2021-09-01' })
 => [#<PirschApi::Visitor day="2021-09-01T00:00:00Z", visitors=76, views=161, sessions=110, bounces=48, bounce_rate=0.631578947368421>, #<PirschApi::Visitor day="2021-09-02T00:00:00Z", visitors=79, views=152, sessions=130, bounces=52, bounce_rate=0.6582278481012658>, #<PirschApi::Visitor day="2021-09-03T00:00:00Z", visitors=53, views=109, sessions=68, bounces=26, bounce_rate=0.49056603773584906>, #<PirschApi::Visitor day="2021-09-04T00:00:00Z", visitors=54, views=126, sessions=71, bounces=31, bounce_rate=0.5740740740740741>, #<PirschApi::Visitor day="2021-09-05T00:00:00Z", visitors=116, views=202, sessions=131, bounces=84, bounce_rate=0.7241379310344828>, #<PirschApi::Visitor day="2021-09-06T00:00:00Z", visitors=1, views=1, sessions=1, bounces=1, bounce_rate=1>]
 
-client.visitors(domain: d, filters: { from: '2021-09-01' }).first.day
+client.visitors(domain: domain, filters: { from: '2021-09-01' }).first.day
 => "2021-09-01T00:00:00Z"
 
 # Get /statistics/active
-client.active(domain: d)
+client.active(domain: domain)
 => #<PirschApi::Active stats=nil, visitors=0>
-client.active(domain: d).visitors
+
+client.active(domain: domain).visitors
 => 0
 ```
 

data/lib/pirsch_api/client.rb

@@ -57,5 +57,13 @@ module PirschApi
     def utm_campaign(filters: {}, domain:)
       UtmCampaignResource.new(client: self, filters: filters, domain: domain).run
     end
+
+    def duration_session(filters: {}, domain:)
+      DurationSessionResource.new(client: self, filters: filters, domain: domain).run
+    end
+
+    def duration_page(filters: {}, domain:)
+      DurationPageResource.new(client: self, filters: filters, domain: domain).run
+    end
   end
 end

data/lib/pirsch_api/objects/duration_page.rb

@@ -0,0 +1,4 @@
+module PirschApi
+  class DurationPage < Object
+  end
+end

data/lib/pirsch_api/objects/duration_session.rb

@@ -0,0 +1,4 @@
+module PirschApi
+  class DurationSession < Object
+  end
+end

data/lib/pirsch_api/resources/statistics/duration_page.rb

@@ -0,0 +1,11 @@
+module PirschApi
+  class DurationPageResource < BaseResource
+    def request_url
+      "statistics/duration/page"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body).map{ |o| DurationPage.new o }
+    end
+  end
+end

data/lib/pirsch_api/resources/statistics/duration_session.rb

@@ -0,0 +1,11 @@
+module PirschApi
+  class DurationSessionResource < BaseResource
+    def request_url
+      "statistics/duration/session"
+    end
+    
+    def parse_response(body)
+      JSON.parse(body).map{ |o| DurationSession.new o }
+    end
+  end
+end

data/lib/pirsch_api/version.rb

@@ -1,3 +1,3 @@
 module PirschApi
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/pirsch_api.rb

@@ -21,6 +21,8 @@ module PirschApi
   autoload :UtmSourceResource, "pirsch_api/resources/statistics/utm_source"
   autoload :UtmCampaignResource, "pirsch_api/resources/statistics/utm_campaign"
   autoload :UtmMediumResource, "pirsch_api/resources/statistics/utm_medium"
+  autoload :DurationSessionResource, "pirsch_api/resources/statistics/duration_session"
+  autoload :DurationPageResource, "pirsch_api/resources/statistics/duration_page"
 
   autoload :Object, "pirsch_api/object"
   autoload :Token, "pirsch_api/objects/token"
@@ -34,4 +36,6 @@ module PirschApi
   autoload :UtmSource, "pirsch_api/objects/utm_source"
   autoload :UtmCampaign, "pirsch_api/objects/utm_campaign"
   autoload :UtmMedium, "pirsch_api/objects/utm_medium"
+  autoload :DurationSession, "pirsch_api/objects/duration_session"
+  autoload :DurationPage, "pirsch_api/objects/duration_page"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pirsch_api
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-09-06 00:00:00.000000000 Z
+date: 2021-09-15 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the API by Pirsch.io
 email:
@@ -32,6 +32,8 @@ files:
 - lib/pirsch_api/object.rb
 - lib/pirsch_api/objects/active.rb
 - lib/pirsch_api/objects/domain.rb
+- lib/pirsch_api/objects/duration_page.rb
+- lib/pirsch_api/objects/duration_session.rb
 - lib/pirsch_api/objects/event.rb
 - lib/pirsch_api/objects/growth.rb
 - lib/pirsch_api/objects/page.rb
@@ -44,6 +46,8 @@ files:
 - lib/pirsch_api/resources/base.rb
 - lib/pirsch_api/resources/domain.rb
 - lib/pirsch_api/resources/statistics/active.rb
+- lib/pirsch_api/resources/statistics/duration_page.rb
+- lib/pirsch_api/resources/statistics/duration_session.rb
 - lib/pirsch_api/resources/statistics/event.rb
 - lib/pirsch_api/resources/statistics/growth.rb
 - lib/pirsch_api/resources/statistics/page.rb