plausible_api 0.0.3 → 0.1.0

Sign up to get free protection for your applications and to get access to all the features.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 3960123efcdafae0607d993403d5d3ed6108952b623e282e08d97abe5d68b337
4
- data.tar.gz: 7c03a6435a1d62ca54c07969e09141a546014b093b5ac6e1150b33031f0bdbbf
3
+ metadata.gz: 799fea9f2d094075ca64a58235d62031d0f701c62b031e7f15982bbf2595d36e
4
+ data.tar.gz: 2a4de4e741a1cee1858dfe132102c5a2d937a27382134b80e6a8e4ca28fa327c
5
5
  SHA512:
6
- metadata.gz: 5b6330d478c5affc54605998832e32d38f72659099279f40cb550a84eda0c0593b61efe0af7c7b0ff581e93ed2c191c47518a9eb6d9fee73fb68617372d85f1f
7
- data.tar.gz: 53a8202c35ce4507e6144ffb3623ef899822b179b11b716ec60a079aefbbb2fea89d0be1c4e31e6b625c8540dfb5a1160d81224d2a06af9b31d848e422743830
6
+ metadata.gz: 57f336396b61f956dc2814fb1de4f628d7e0070334789488d0aa2ec257aec09f4ad6ef93e6fecef490049aa6884cccc72c5b2a56277bd0567923ceb1bc8b4750
7
+ data.tar.gz: 635da11edc92ad2c69a6bcff7b1ea4211595c180babe00ca480450195151ec9270c1c1847067ad245dd720d5e4d2bcd833a3168fc212bf40bfde82831a5c213e
data/.gitignore CHANGED
@@ -1 +1,9 @@
1
- *.gem
1
+ /.bundle/
2
+ /.yardoc
3
+ /_yardoc/
4
+ /coverage/
5
+ /doc/
6
+ /pkg/
7
+ /spec/reports/
8
+ /tmp/
9
+ *.gem
@@ -0,0 +1,74 @@
1
+ # Contributor Covenant Code of Conduct
2
+
3
+ ## Our Pledge
4
+
5
+ In the interest of fostering an open and welcoming environment, we as
6
+ contributors and maintainers pledge to making participation in our project and
7
+ our community a harassment-free experience for everyone, regardless of age, body
8
+ size, disability, ethnicity, gender identity and expression, level of experience,
9
+ nationality, personal appearance, race, religion, or sexual identity and
10
+ orientation.
11
+
12
+ ## Our Standards
13
+
14
+ Examples of behavior that contributes to creating a positive environment
15
+ include:
16
+
17
+ * Using welcoming and inclusive language
18
+ * Being respectful of differing viewpoints and experiences
19
+ * Gracefully accepting constructive criticism
20
+ * Focusing on what is best for the community
21
+ * Showing empathy towards other community members
22
+
23
+ Examples of unacceptable behavior by participants include:
24
+
25
+ * The use of sexualized language or imagery and unwelcome sexual attention or
26
+ advances
27
+ * Trolling, insulting/derogatory comments, and personal or political attacks
28
+ * Public or private harassment
29
+ * Publishing others' private information, such as a physical or electronic
30
+ address, without explicit permission
31
+ * Other conduct which could reasonably be considered inappropriate in a
32
+ professional setting
33
+
34
+ ## Our Responsibilities
35
+
36
+ Project maintainers are responsible for clarifying the standards of acceptable
37
+ behavior and are expected to take appropriate and fair corrective action in
38
+ response to any instances of unacceptable behavior.
39
+
40
+ Project maintainers have the right and responsibility to remove, edit, or
41
+ reject comments, commits, code, wiki edits, issues, and other contributions
42
+ that are not aligned to this Code of Conduct, or to ban temporarily or
43
+ permanently any contributor for other behaviors that they deem inappropriate,
44
+ threatening, offensive, or harmful.
45
+
46
+ ## Scope
47
+
48
+ This Code of Conduct applies both within project spaces and in public spaces
49
+ when an individual is representing the project or its community. Examples of
50
+ representing a project or community include using an official project e-mail
51
+ address, posting via an official social media account, or acting as an appointed
52
+ representative at an online or offline event. Representation of a project may be
53
+ further defined and clarified by project maintainers.
54
+
55
+ ## Enforcement
56
+
57
+ Instances of abusive, harassing, or otherwise unacceptable behavior may be
58
+ reported by contacting the project team at luctus@gmail.com. All
59
+ complaints will be reviewed and investigated and will result in a response that
60
+ is deemed necessary and appropriate to the circumstances. The project team is
61
+ obligated to maintain confidentiality with regard to the reporter of an incident.
62
+ Further details of specific enforcement policies may be posted separately.
63
+
64
+ Project maintainers who do not follow or enforce the Code of Conduct in good
65
+ faith may face temporary or permanent repercussions as determined by other
66
+ members of the project's leadership.
67
+
68
+ ## Attribution
69
+
70
+ This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
71
+ available at [https://contributor-covenant.org/version/1/4][version]
72
+
73
+ [homepage]: https://contributor-covenant.org
74
+ [version]: https://contributor-covenant.org/version/1/4/
data/Gemfile ADDED
@@ -0,0 +1,7 @@
1
+ source "https://rubygems.org"
2
+
3
+ # Specify your gem's dependencies in plausible_api.gemspec
4
+ gemspec
5
+
6
+ gem "rake", "~> 12.0"
7
+ gem "minitest", "~> 5.0"
data/Gemfile.lock ADDED
@@ -0,0 +1,29 @@
1
+ PATH
2
+ remote: .
3
+ specs:
4
+ plausible_api (0.1.0)
5
+ faraday (~> 1.0)
6
+
7
+ GEM
8
+ remote: https://rubygems.org/
9
+ specs:
10
+ faraday (1.3.0)
11
+ faraday-net_http (~> 1.0)
12
+ multipart-post (>= 1.2, < 3)
13
+ ruby2_keywords
14
+ faraday-net_http (1.0.1)
15
+ minitest (5.14.3)
16
+ multipart-post (2.1.1)
17
+ rake (12.3.3)
18
+ ruby2_keywords (0.0.4)
19
+
20
+ PLATFORMS
21
+ ruby
22
+
23
+ DEPENDENCIES
24
+ minitest (~> 5.0)
25
+ plausible_api!
26
+ rake (~> 12.0)
27
+
28
+ BUNDLED WITH
29
+ 2.1.4
data/LICENSE.txt ADDED
@@ -0,0 +1,21 @@
1
+ The MIT License (MIT)
2
+
3
+ Copyright (c) 2021 Gustavo Garcia
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in
13
+ all copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
21
+ THE SOFTWARE.
data/README.md CHANGED
@@ -50,14 +50,22 @@ You have a uniq way to call this data
50
50
  c.realtime_visitors
51
51
  ```
52
52
 
53
+
53
54
  ## Development
54
- ```
55
- $ gem build plausible_api.gemspec
56
- $ gem install ./plausible_api-X.X.X.gem
57
- $ irb
58
- irb(main) > require 'plausible_api'
59
- ```
60
55
 
61
- ## Todo
62
- - Tests
63
- - Options validation
56
+ 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.
57
+
58
+ To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
59
+
60
+ ## Contributing
61
+
62
+ Bug reports and pull requests are welcome on GitHub at https://github.com/dailytics/plausible_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/dailytics/plausible_api/blob/master/CODE_OF_CONDUCT.md).
63
+
64
+
65
+ ## License
66
+
67
+ The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
68
+
69
+ ## Code of Conduct
70
+
71
+ Everyone interacting in the PlausibleApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/dailytics/plausible_api/blob/master/CODE_OF_CONDUCT.md).
data/Rakefile ADDED
@@ -0,0 +1,10 @@
1
+ require "bundler/gem_tasks"
2
+ require "rake/testtask"
3
+
4
+ Rake::TestTask.new(:test) do |t|
5
+ t.libs << "test"
6
+ t.libs << "lib"
7
+ t.test_files = FileList["test/**/*_test.rb"]
8
+ end
9
+
10
+ task :default => :test
data/bin/console ADDED
@@ -0,0 +1,14 @@
1
+ #!/usr/bin/env ruby
2
+
3
+ require "bundler/setup"
4
+ require "plausible_api"
5
+
6
+ # You can add fixtures and/or initialization code here to make experimenting
7
+ # with your gem easier. You can also use a different console, if you like.
8
+
9
+ # (If you use this, don't forget to add pry to your Gemfile!)
10
+ # require "pry"
11
+ # Pry.start
12
+
13
+ require "irb"
14
+ IRB.start(__FILE__)
data/bin/setup ADDED
@@ -0,0 +1,8 @@
1
+ #!/usr/bin/env bash
2
+ set -euo pipefail
3
+ IFS=$'\n\t'
4
+ set -vx
5
+
6
+ bundle install
7
+
8
+ # Do any other automated setup that you need to do here
data/lib/plausible_api.rb CHANGED
@@ -1,13 +1,7 @@
1
- # frozen_string_literal: true
2
-
3
- require 'plausible_api/api/client'
1
+ require 'plausible_api/version'
2
+ require 'plausible_api/client'
4
3
 
5
4
  module PlausibleApi
6
- class << self
7
- attr_writer :logger
8
-
9
- def logger
10
- @logger ||= Logger.new($stdout).tap { |log| log.progname = self.name }
11
- end
12
- end
13
- end
5
+ class Error < StandardError; end
6
+ # Your code goes here...
7
+ end
@@ -1,8 +1,8 @@
1
1
  # frozen_string_literal: true
2
2
 
3
- require 'plausible_api/api/stats/realtime/visitors'
4
- require 'plausible_api/api/stats/aggregate'
5
- require 'plausible_api/api/stats/timeseries'
3
+ require 'plausible_api/stats/realtime/visitors'
4
+ require 'plausible_api/stats/aggregate'
5
+ require 'plausible_api/stats/timeseries'
6
6
 
7
7
  require 'faraday'
8
8
  require 'json'
File without changes
@@ -1,3 +1,3 @@
1
1
  module PlausibleApi
2
- VERSION = '0.0.3'
3
- end
2
+ VERSION = "0.1.0"
3
+ end
@@ -1,22 +1,29 @@
1
- # frozen_string_literal: true
1
+ require_relative 'lib/plausible_api/version'
2
2
 
3
- lib = File.expand_path('lib', __dir__)
4
- $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
3
+ Gem::Specification.new do |spec|
4
+ spec.name = "plausible_api"
5
+ spec.version = PlausibleApi::VERSION
6
+ spec.authors = ["Gustavo Garcia"]
7
+ spec.email = ["gustavo@dailytics.com"]
5
8
 
6
- require 'plausible_api/version'
9
+ spec.summary = 'A simple Plausible API wrapper for Rails'
10
+ spec.description = 'A very humble wrapper for the new API by Plausible'
11
+ spec.homepage = "https://github.com/dailytics/plausible_api"
12
+ spec.license = "MIT"
13
+ spec.required_ruby_version = Gem::Requirement.new(">= 2.3.0")
7
14
 
8
- Gem::Specification.new do |s|
9
- s.name = 'plausible_api'
10
- s.version = PlausibleApi::VERSION
11
- s.summary = 'A simple Plausible API wrapper for Rails'
12
- s.description = 'A very humble wrapper for the new API by Plausible'
13
- s.authors = ['Gustavo Garcia']
14
- s.email = 'gustavo@dailytics.com'
15
- s.homepage = 'https://github.com/dailytics/plausible-api'
16
- s.license = 'MIT'
17
- s.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(spec)/}) }
18
- s.require_paths = ['lib']
15
+ spec.metadata["homepage_uri"] = spec.homepage
16
+ spec.metadata["source_code_uri"] = "https://github.com/dailytics/plausible_api"
17
+ spec.metadata["changelog_uri"] = "https://github.com/dailytics/plausible_api"
19
18
 
20
- s.add_dependency 'faraday', '~> 1.0'
21
- s.required_ruby_version = '>= 2.4'
22
- end
19
+ # Specify which files should be added to the gem when it is released.
20
+ # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
21
+ spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
22
+ `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
23
+ end
24
+ spec.bindir = "exe"
25
+ spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
26
+ spec.require_paths = ["lib"]
27
+
28
+ spec.add_dependency 'faraday', '~> 1.0'
29
+ end
metadata CHANGED
@@ -1,14 +1,14 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: plausible_api
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.0.3
4
+ version: 0.1.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Gustavo Garcia
8
8
  autorequire:
9
- bindir: bin
9
+ bindir: exe
10
10
  cert_chain: []
11
- date: 2021-02-10 00:00:00.000000000 Z
11
+ date: 2021-02-12 00:00:00.000000000 Z
12
12
  dependencies:
13
13
  - !ruby/object:Gem::Dependency
14
14
  name: faraday
@@ -25,24 +25,35 @@ dependencies:
25
25
  - !ruby/object:Gem::Version
26
26
  version: '1.0'
27
27
  description: A very humble wrapper for the new API by Plausible
28
- email: gustavo@dailytics.com
28
+ email:
29
+ - gustavo@dailytics.com
29
30
  executables: []
30
31
  extensions: []
31
32
  extra_rdoc_files: []
32
33
  files:
33
34
  - ".gitignore"
35
+ - CODE_OF_CONDUCT.md
36
+ - Gemfile
37
+ - Gemfile.lock
38
+ - LICENSE.txt
34
39
  - README.md
40
+ - Rakefile
41
+ - bin/console
42
+ - bin/setup
35
43
  - lib/plausible_api.rb
36
- - lib/plausible_api/api/client.rb
37
- - lib/plausible_api/api/stats/aggregate.rb
38
- - lib/plausible_api/api/stats/realtime/visitors.rb
39
- - lib/plausible_api/api/stats/timeseries.rb
44
+ - lib/plausible_api/client.rb
45
+ - lib/plausible_api/stats/aggregate.rb
46
+ - lib/plausible_api/stats/realtime/visitors.rb
47
+ - lib/plausible_api/stats/timeseries.rb
40
48
  - lib/plausible_api/version.rb
41
49
  - plausible_api.gemspec
42
- homepage: https://github.com/dailytics/plausible-api
50
+ homepage: https://github.com/dailytics/plausible_api
43
51
  licenses:
44
52
  - MIT
45
- metadata: {}
53
+ metadata:
54
+ homepage_uri: https://github.com/dailytics/plausible_api
55
+ source_code_uri: https://github.com/dailytics/plausible_api
56
+ changelog_uri: https://github.com/dailytics/plausible_api
46
57
  post_install_message:
47
58
  rdoc_options: []
48
59
  require_paths:
@@ -51,7 +62,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
51
62
  requirements:
52
63
  - - ">="
53
64
  - !ruby/object:Gem::Version
54
- version: '2.4'
65
+ version: 2.3.0
55
66
  required_rubygems_version: !ruby/object:Gem::Requirement
56
67
  requirements:
57
68
  - - ">="