majestic-api 1.4.0 → 1.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1e1e35e83bb4074c2fea067e5049b0b7407ae08237b8d85ace5a76b081243fa9
-  data.tar.gz: afaf42abf89b9efbd9f79acfaea72ac20d26d0375843ab044f7a2d1a151ae69a
+  metadata.gz: bef0b400e5ecfc161a111c7459ef16bdccf346eb9f2cea4070474a0413175f59
+  data.tar.gz: '0706385753f7434ef16d2a1eb4b39c0210c5db8418bead7b612f9391be12e18f'
 SHA512:
-  metadata.gz: c6e2531fcae909e043e635e2ff75b40f992bcbf42ce18a5a19a9c12f61ce9cbabab6a659ef2c7ba9ffab05c73e6011fc49743fd8e92140a6a1db3d61a4300293
-  data.tar.gz: 25f597ae88854e0ce91cf2c5490ab9d8079aca5b1bdb6d6220f2371f1beea291f8e1fa77beeeb008f0bf8fa87c82eb8988e56434263e1a0a7f45cdc8e7fed586
+  metadata.gz: 877c69ddd75203342287776d082309ae63c4fee64c74b377357a93cd5e813c7cbab6b55f5f8b90c6768d92296e37264051304b15af770d426f9e212ff9eeb083
+  data.tar.gz: '01833611f7a17857118d00a7120d66693abd8ca4c596f77e5a1a945f83ce97a9b5f606b940f76df5f0e8d53b8adbc2bbe6c952cf16d350c78d3d39f2f012b412'

data/.gitignore

@@ -17,4 +17,4 @@
 
 credentials.yml
 .ruby-version
-.ruby-gemset
+.ruby-gemset.DS_Store

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    majestic-api (1.4.0)
+    majestic-api (1.4.1)
       faraday (>= 0.15.4)
       faraday_middleware (>= 0.13.1)
 

data/README.markdown

@@ -1,4 +1,4 @@
-# Majestic Ruby API Client #
+# Majestic Ruby API Client
 
 Client intended to be used with [Majestic's API](http://developer-support.majesticseo.com/).
 
@@ -6,20 +6,58 @@ This gem is forked/rewritten based on [https://github.com/SebastianJ/Majestic-SE
 
 Majestic dropped the "SEO" brand a long time ago and the previous client's name was out of sync with this change.
 
-The client has also been slightly rewritten and prepared to be easier to maintain.
+The client has also been slightly rewritten and has been prepared to be easier to maintain.
 
-## Installation ##
+## Installation
 ```
 gem install majestic-api
 ```
 
-## Configuration ##
+## Configuration
 ```
 Majestic::Api.configure do |config|
-  config.environment  =   :production # The environment to use, valid values: :sandbox, :production
   config.api_key      =   'api_key' # Your API key provided by Majestic
-  config.verbose      =   false # Set to true to enable Faraday's logging middleware to get more information
+  config.environment  =   :production # The environment to use, valid values: :sandbox, :production
+  config.verbose      =   false # Set to true to enable logging + Faraday's logging middleware to get more information
 end
 ```
 
-If you're using Rails, create an initializer in config/initializers/majestic.rb to configure the client globally in your app.
+To generate an initializer execute the following command:
+
+```ruby
+rails g majestic:api:install Majestic
+```
+
+## Usage
+
+```ruby
+client    =   ::Majestic::Api::Client.new
+data      =   client.get_index_item_info(urls: ["google.com", "yahoo.com"], params: {data_source: :historic})
+data.items&.each { |item| puts "Historic Trust Flow for domain '#{item.url}' is: #{item.trust_flow}"}
+```
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies.
+
+Copy credentials.yml.example to credentials.yml and enter your API key in that file.
+
+Run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+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).
+
+## Testing
+
+Please be aware that removing any of the VCR cassettes under spec/fixtures/vcr_cassettes and re-running the specs might lead to sensitive/personal data being stored in the newly generated cassettes!
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SebastianJ/majestic-api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the Adtraction::Api project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/SebastianJ/majestic-api/blob/master/CODE_OF_CONDUCT.md).

data/credentials.yml.example

@@ -0,0 +1,11 @@
+development:
+  environment: production
+  api_key: "YOUR_API_KEY"
+
+test:
+  environment: production
+  api_key: "YOUR_API_KEY"
+
+production:
+  environment: production
+  api_key: "YOUR_API_KEY"

data/lib/generators/majestic/api/install_generator.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+require "rails/generators/base"
+
+module Majestic
+  module Api
+    module Generators
+      class InstallGenerator < Rails::Generators::NamedBase
+        include Rails::Generators::ResourceHelpers
+        
+        source_root File.expand_path('templates', __dir__)
+
+        desc "Creates an initializer for Majestic::Api for your Rails application."
+        
+        def copy_initializer_file
+          copy_file "config.rb", "config/initializers/majestic_api.rb"
+        end
+      
+      end
+    end
+  end
+end

data/lib/generators/majestic/api/templates/config.rb

@@ -0,0 +1,5 @@
+Majestic::Api.configure do |config|
+  config.api_key      =   "ENTER_YOUR_API_KEY_HERE"
+  config.environment  =   :production
+  config.verbose      =   false
+end

data/lib/majestic/api/version.rb

@@ -1,5 +1,5 @@
 module Majestic
   module Api
-    VERSION = "1.4.0"
+    VERSION = "1.4.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: majestic-api
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.4.1
 platform: ruby
 authors:
 - Sebastian Johnsson
@@ -143,7 +143,6 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".DS_Store"
 - ".gitignore"
 - CODE_OF_CONDUCT.md
 - Gemfile
@@ -153,6 +152,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- credentials.yml.example
+- lib/generators/majestic/api/install_generator.rb
+- lib/generators/majestic/api/templates/config.rb
 - lib/majestic/api.rb
 - lib/majestic/api/client.rb
 - lib/majestic/api/configuration.rb