simple_analytics_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad37e11e9775b0df35b8576f8ed0f3152ba4a363434a11b348297dca6f11ada8
-  data.tar.gz: c685fb99c7350ae58d7bf8771ff12f55d0b56931de1383e679b206b31afd643e
+  metadata.gz: 8b697125278b698423c8e0a8e41dd8ca7df6dd2519a51ff8c9ad58d6ef9d2f4f
+  data.tar.gz: c733e756e1ae71870b68ce82beac545331ba50db62083140222d514b1467388c
 SHA512:
-  metadata.gz: e4713798681903cf286e1779b66726f4ffb2873a64d13528ec98571ca29008e69c16f6859173d86238488eda3e792f1e340964324e553c1b09b022776328be7a
-  data.tar.gz: d1c6c6fe3a52a510426072daca08361604c2371158cc0dbca879dde91e36e3a2061451a3eeacc83cea1611000936a680c9b59aa1c2c1c76725f9fd6ca3c2dca8
+  metadata.gz: 153c3a70e9ca2d91f60c0eff6cac580c911e3dfabe60d65a6f1a77588523df25a3ec364735850277df819bd1039bca03e67260cf4c9cf5711f54919bb22fe835
+  data.tar.gz: 3529f9a7e3f94466370d84590870d5e99339897dfb399d10498df3ebb6f0537e77d7a9807125971e998fc23e6c1f0fb9aae32dab7c8af6d6de782186c8505c74

data/Gemfile.lock

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

data/README.md

@@ -25,9 +25,27 @@ client.run(
   fields: %w(pageviews visitors pages), 
   filters: {
     start: '2021-01-01 00:00', 
-    end: '2021-01-31 23:59'
+    end: '2021-01-05 23:59'
   }
-)
+).pages
+=> [#<OpenStruct value="/", pageviews=36, visitors=28>, #<OpenStruct value="/may-2020-all-stripe-data-explained-and-we-just-hit-6000-usd-mrr", pageviews=14, visitors=2>, #<OpenStruct value="/how-we-hit-our-30k-annual-recurring-revenue-milestone", pageviews=5, visitors=4>, #<OpenStruct value="/why-we-moved-our-servers-to-iceland", pageviews=5, visitors=2>, #<OpenStruct value="/april-2020-we-hit-400-paying-customers", pageviews=4, visitors=3>, #<OpenStruct value="/practical-privacy-tips-for-your-business", pageviews=2, visitors=2>]
+```
+The `run` command will also include some other helpful information, like this:
+```rb
+=> #<SimpleAnalyticsApi::Object ok=true, docs="https://docs.simpleanalytics.com/api", info="false", hostname="blog.simpleanalytics.com", url="https://blog.simpleanalytics.com", path="*", start="2021-01-01T00:00:00.000Z", end="2021-01-06T23:59:59.999Z", version=5, timezone="UTC", pageviews=66, visitors=41, pages=...the-content-that-you-see-above..., generated_in_ms=398>
+```
+
+You can also include a `debug` parameter if you want to see the final URL that is going
+to be called, like this:
+```rb
+client.run(
+  fields: %w(pageviews visitors pages), 
+  filters: {
+    start: '2021-01-01 00:00', 
+    end: '2021-01-05 23:59'
+  },
+  debug: true
+).pages
 ```
 
 ## Development

data/lib/simple_analytics_api/client.rb

@@ -19,8 +19,8 @@ module SimpleAnalyticsApi
       Website.new(client: self).run
     end
 
-    def run(fields: [], filters: {})
-      Resource.new(client: self, fields: fields, filters: filters).run
+    def run(fields: [], filters: {}, debug: false)
+      Resource.new(client: self, fields: fields, filters: filters, debug: debug).run
     end
   end
 end

data/lib/simple_analytics_api/resource.rb

@@ -3,15 +3,18 @@ module SimpleAnalyticsApi
 
     BASE_URL = 'https://simpleanalytics.com'
 
-    attr_accessor :client, :fields, :filters, :domain
+    attr_accessor :client, :fields, :filters, :domain, :debug
 
-    def initialize(client:, domain: nil, fields: [], filters: {})
+    def initialize(client:, domain: nil, fields: [], filters: {}, debug: false)
       @client  = client
       @fields  = fields
       @filters = filters
       @domain  = domain || client.domain
+      @debug   = debug
       @filters[:version] = 5 unless @filters[:version]
+      @filters[:info] = false unless @debug
       @fields = [:pageviews] unless @fields.any?
+      
     end
 
     def fields_and_filters
@@ -32,6 +35,7 @@ module SimpleAnalyticsApi
     end
 
     def run
+      puts "[SimpleAnalyticsAPI] #{url}" if debug
       uri = URI.parse url
       req = Net::HTTP::Get.new(uri.request_uri)
       req.add_field('Content-Type', 'application/json')

data/lib/simple_analytics_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: simple_analytics_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Gustavo Garcia
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-10-16 00:00:00.000000000 Z
+date: 2021-10-18 00:00:00.000000000 Z
 dependencies: []
 description: A very humble wrapper for the API by simpleanalytics.io
 email: