rocketvalidator 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4aedbc6ca2a95747ff55d0e87e26c3c56c48ee637ef954961a53c3b0eef6f258
-  data.tar.gz: 977a495eb2224080c69d7d97b7efedc1eb69443a32d9d532381407df514a068e
+  metadata.gz: 39b4a780276b46638489a877009039dc0b4b22569c3a47e91997ec70ee032830
+  data.tar.gz: 198ab807eb9e87f76cb816722e26e3f8cd7d1556b29e55edf6d6ac0a6d1cf1df
 SHA512:
-  metadata.gz: 5fa36ec9d1b035e0b0176f541ee56104cdfecdb611d661aaa9b35bfa2615dcb0c59c7dc49f491a0d0105bc47a6dd228252f84770f4b247a9e680521674f8a55f
-  data.tar.gz: 54d2b6994dd5d11ee02356d862bbf6a582b680dcde962fbaaa372b71d9ecd0e812250e022dd85bec32f9e5c14f6eb130145dff4279de8c7301f0a6076f8f04a9
+  metadata.gz: b648c82b295c5b4f59ef577ed4ded56b87a8b7202f2a2e03e1c4dcec617170b08ab26dbe6a0122ce3a6b323e2f638039689fe91e369243342ad554937c258fe9
+  data.tar.gz: c2e0eeb30038a433908b03b0731a299c6fa92914eb9d12dcbe1d881ac4b3c4d981dd3b807df07d5babed682469161cc22590baad08f657998cc3bc990b4428c5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rocketvalidator (0.1.0)
+    rocketvalidator (0.2.0)
       json_api_client (~> 1.16, >= 1.16.1)
 
 GEM

data/README.md

@@ -1,8 +1,6 @@
-# Rocketvalidator
+# Rocket Validator
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/rocketvalidator`. To experiment with that code, run `bin/console` for an interactive prompt.
-
-TODO: Delete this and the text above, and describe your gem
+Welcome to the official [Rocket Validator API](https://docs.rocketvalidator.com/api) gem!
 
 ## Installation
 
@@ -22,9 +20,9 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Watch out this space for examples :)
 
-## Development
+## Gem Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
 
@@ -32,7 +30,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/jaimeiniesta/rocketvalidator. 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/jaimeiniesta/rocketvalidator/blob/master/CODE_OF_CONDUCT.md).
+Bug reports and pull requests are welcome on GitHub at https://github.com/rocketvalidator/rocketvalidator-ruby. 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/rocketvalidator/rocketvalidator-ruby/blob/master/CODE_OF_CONDUCT.md).
 
 
 ## License
@@ -41,4 +39,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rocketvalidator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/jaimeiniesta/rocketvalidator/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rocketvalidator project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/rocketvalidator/rocketvalidator-ruby/blob/master/CODE_OF_CONDUCT.md).

data/lib/rocketvalidator.rb

@@ -1,35 +1,14 @@
-require "rocketvalidator/version"
 require "json_api_client"
 
-JsonApiClient::Paginating::NestedParamPaginator.page_param = "number"
-JsonApiClient::Paginating::NestedParamPaginator.per_page_param = "size"
+require "rocketvalidator/version"
+require "rocketvalidator/configuration"
+require "rocketvalidator/v0/resource"
+require "rocketvalidator/v0/report"
+require "rocketvalidator/v0/web_page"
+require "rocketvalidator/v0/common_a11y_issue"
+require "rocketvalidator/v0/common_html_issue"
+require "rocketvalidator/v0/a11y_issue"
+require "rocketvalidator/v0/html_issue"
 
 module RocketValidator
-  class Base < JsonApiClient::Resource
-    self.site = "https://rocketvalidator.dev/api/v0/"
-    self.paginator = JsonApiClient::Paginating::NestedParamPaginator
-  end
-
-  class Report < Base
-  end
-
-  class WebPage < Base
-    belongs_to :report
-    belongs_to :common_html_issue
-  end
-
-  class CommonHtmlIssue < Base
-    belongs_to :report
-  end
-
-  class HtmlIssue < Base
-    belongs_to :report
-    belongs_to :web_page
-  end
-
-  def self.with_api_token(api_token, &block)
-    RocketValidator::Base.with_headers("Authorization" => "Bearer #{api_token}") do
-      block.call
-    end
-  end
 end

data/lib/rocketvalidator/configuration.rb

@@ -0,0 +1,2 @@
+JsonApiClient::Paginating::NestedParamPaginator.page_param = "number"
+JsonApiClient::Paginating::NestedParamPaginator.per_page_param = "size"

data/lib/rocketvalidator/v0/a11y_issue.rb

@@ -0,0 +1,8 @@
+module RocketValidator
+  module V0
+    class A11yIssue < Resource
+      belongs_to :report
+      belongs_to :web_page
+    end
+  end
+end

data/lib/rocketvalidator/v0/common_a11y_issue.rb

@@ -0,0 +1,7 @@
+module RocketValidator
+  module V0
+    class CommonA11yIssue < Resource
+      belongs_to :report
+    end
+  end
+end

data/lib/rocketvalidator/v0/common_html_issue.rb

@@ -0,0 +1,7 @@
+module RocketValidator
+  module V0
+    class CommonHtmlIssue < Resource
+      belongs_to :report
+    end
+  end
+end

data/lib/rocketvalidator/v0/html_issue.rb

@@ -0,0 +1,8 @@
+module RocketValidator
+  module V0
+    class HtmlIssue < Resource
+      belongs_to :report
+      belongs_to :web_page
+    end
+  end
+end

data/lib/rocketvalidator/v0/report.rb

@@ -0,0 +1,6 @@
+module RocketValidator
+  module V0
+    class Report < Resource
+    end
+  end
+end

data/lib/rocketvalidator/v0/resource.rb

@@ -0,0 +1,14 @@
+module RocketValidator
+  module V0
+    class Resource < JsonApiClient::Resource
+      self.site = "https://rocketvalidator.dev/api/v0/"
+      self.paginator = JsonApiClient::Paginating::NestedParamPaginator
+
+      def self.with_api_token(token)
+        with_headers(authorization: "Bearer #{token}") do
+          yield
+        end
+      end
+    end
+  end
+end

data/lib/rocketvalidator/v0/web_page.rb

@@ -0,0 +1,7 @@
+module RocketValidator
+  module V0
+    class WebPage < Resource
+      belongs_to :report
+    end
+  end
+end

data/lib/rocketvalidator/version.rb

@@ -1,3 +1,3 @@
-module Rocketvalidator
-  VERSION = "0.1.0"
+module RocketValidator
+  VERSION = "0.2.0"
 end

data/rocketvalidator.gemspec

@@ -2,7 +2,7 @@ require_relative 'lib/rocketvalidator/version'
 
 Gem::Specification.new do |spec|
   spec.name          = "rocketvalidator"
-  spec.version       = Rocketvalidator::VERSION
+  spec.version       = RocketValidator::VERSION
   spec.authors       = ["Jaime Iniesta"]
   spec.email         = ["jaimeiniesta@gmail.com"]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rocketvalidator
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Jaime Iniesta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-04-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json_api_client
@@ -48,6 +48,14 @@ files:
 - bin/console
 - bin/setup
 - lib/rocketvalidator.rb
+- lib/rocketvalidator/configuration.rb
+- lib/rocketvalidator/v0/a11y_issue.rb
+- lib/rocketvalidator/v0/common_a11y_issue.rb
+- lib/rocketvalidator/v0/common_html_issue.rb
+- lib/rocketvalidator/v0/html_issue.rb
+- lib/rocketvalidator/v0/report.rb
+- lib/rocketvalidator/v0/resource.rb
+- lib/rocketvalidator/v0/web_page.rb
 - lib/rocketvalidator/version.rb
 - rocketvalidator.gemspec
 homepage: https://docs.rocketvalidator.com/api