pirsch_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f23f5623a3fd98b5f09a7190b83e86a9f8a7fe4f4403ba3da9387f2fe98cc3a1
-  data.tar.gz: 6137f3417cd67bffbe7be5d48fc5cfcd963d5b650f0998a1ce75da3c8547f285
+  metadata.gz: b41470047653a8abd5e3eff60fe44bef1d2afb51c82279ef48879be999fc8243
+  data.tar.gz: fdb4e7546d50d6049f48e727781ecb2e9395b105e4149aa01e83070340c97c43
 SHA512:
-  metadata.gz: 0755236fcf745ccf413778bddb08e14c71330dddfbc1f1cb98991e29d708a1ec5d4a714516d452fc42d5cc032a662eb1ad1ff90fc4d74abd98ef40c0a3f1583b
-  data.tar.gz: 889498694ba2e82c6fae0fa31e48e21ce09ef538ee02c25112a8ff8388dfd142ce2b8ac2d534924909f2d99a27c790cab19ab55a15f4366c42682f6bb8f0b7eb
+  metadata.gz: 9b4aa5375433d5a9196928eecddbf7d8edfcaa39161853dd84cfe51e1bf9e9bfa71e733755982ecd1014c87a52d995e34acc327911f45ce0d1fd7ea59a0e1979
+  data.tar.gz: 2d0763db86bbaeb91027bbdad1ef3baacb01fe8ebf91e6e80051026e8700a74f44c54b9684c5e3e62c1ee7830e1b0e960645f63d5e100885e67bcda9995768b1

data/Gemfile.lock

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

data/README.md

@@ -4,54 +4,86 @@ It's based on the [API guide](https://docs.pirsch.io/api-sdks/api/)
 
 ## Usage
 Add this gem to your Gemfile:
+
 ```rb
 gem 'pirsch_api'
 ```
-Then you need to initialize a Client with your `client_id` and the `client_secret`.
+
+Now you need to initialize a Client with your `client_id` and the `client_secret`.
+
 ```rb
-c = PirschApi::Client.new(client_id: '<client_id>', client_secret: '<client_secret>') 
+client = PirschApi::Client.new(client_id: '<client_id>', client_secret: '<client_secret>') 
 
 # Test if the credentials are valid
-c.valid?
+client.valid?
 => true
+```
+
+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.
 
+```rb
 # Get /domains
-c.domains
+client.domains
 => [#<PirschApi::Domain id="0D3a...", user_id="0D3a...", hostname="pirsch.io", subdomain="pirsch", ... >]
-c.domains.first.hostname
+domain = c.domains.first
+domain.hostname
 => "pirsch.io"
+domain.id
+=> "0D3a..."
+domain.to_s
+=> "0D3a..."
+```
+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)
+
+# Get /statistics/active
+client.active(domain: domain)
+
+# Get /statistics/pages
+client.pages(domain: domain)
 
-# You will need one domain for all the following requests
-d = c.domains.first
+# Get /statistics/referrers
+client.referrers(domain: domain)
 
-# All the following methods require a `domain` and can receive a `filters` hash
+# Get /statistics/growth
+client.growth(domain: domain)
 
-# Get /statistics/visitor
-c.visitors(domain: d)
+# Get /statistics/events
+client.events(domain: domain)
+
+# Get /statistics/utm/source
+client.utm_source(domain: domain)
+
+# Get /statistics/utm/medium
+client.utm_medium(domain: domain)
+
+# Get /statistics/utm/campaign
+client.utm_campaign(domain: domain)
+```
+
+## Examples
+```rb
+
+client.visitors(domain: d)
 => [#<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>]
-c.visitors(domain: d, 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>]
-c.visitors(domain: d, filters: { from: '2021-09-01' }).first.day
+
+client.visitors(domain: d, 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
 => "2021-09-01T00:00:00Z"
 
 # Get /statistics/active
-c.active(domain: d)
+client.active(domain: d)
 => #<PirschApi::Active stats=nil, visitors=0>
-c.active(domain: d).visitors
+client.active(domain: d).visitors
 => 0
-
-# Other available methods (Remember that they can all receive a `filters` hash)
-c.pages(domain: d)
-c.referrers(domain: d)
-c.active(domain: d)
-c.growth(domain: d)
-c.events(domain: d)
-c.utm_source(domain: d)
-c.utm_medium(domain: d)
-c.utm_campaign(domain: d)
 ```
 
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.

data/lib/pirsch_api/objects/domain.rb

@@ -1,4 +1,7 @@
 module PirschApi
   class Domain < Object
+    def to_s
+      id.to_s
+    end
   end
 end

data/lib/pirsch_api/resources/base.rb

@@ -31,7 +31,7 @@ module PirschApi
       raise PirschApi::Error.new errors unless valid?
       
       if domain
-        filters[:id] = domain.id
+        filters[:id] = domain.to_s
       end
 
       url = "#{PirschApi::Client::BASE_URL}/#{request_url}"

data/lib/pirsch_api/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pirsch_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gustavo Garcia