webceo 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2afe7cb5ced6fb5efa4b94628c9553372f512bd6
-  data.tar.gz: 77c587b23e92819c63feb35f4ad36752feffe890
+  metadata.gz: 271714cff7c51be222dda592a803eb43e5a1b94f
+  data.tar.gz: a0b597a38c8c4f73ced9009f3fb5532dc6fa1a23
 SHA512:
-  metadata.gz: 4a22917d19ca12c9c6e4e44e8ab418f3760143e1a9cf55759913eaa2bd04a8e1eba8a5e8f02e26757a527438a52b16edacb59ddaf1447cdd30d55595a19eb220
-  data.tar.gz: 7380d52ff2de4efb60c88fba54dac127c92c1338cf8ff73635ae669850b908bbaac681610cb5c9f55e738a91bf724c1191b59400f70e01cbdecabcdde671e17e
+  metadata.gz: 5deeba8cadd4933f85756ca281033acc10283359878740fc6fde359a7d7a41379099239becaac45f21fca8e3f5e3be18240d5bbe97a1fbf748af7663cf7d075b
+  data.tar.gz: a25f20e18a168c7ae7cde920c3725e67b3b39ab7b0015d095effcaf8e19ebd9d073d6f7ec2cbdfbfef1ec638ae7172c6a6818c58e783b93f6a3ee06d2815c00e

data/README.md

@@ -1,5 +1,14 @@
 # Webceo
 
+[![Gem Version](https://badge.fury.io/rb/webceo.svg)][gem_version]
+[![Gem](https://img.shields.io/gem/dv/webceo/stable.svg)][gem_downloads]
+![GitHub tag](https://img.shields.io/github/tag/agnel/webceo.svg)
+[![Liberapay receiving](https://img.shields.io/liberapay/receives/agnelwaghela.svg)][liberapay_donate_link]
+
+[gem_version]: https://badge.fury.io/rb/webceo
+[gem_downloads]: https://rubygems.org/gems/webceo
+[liberapay_donate_link]: https://liberapay.com/agnelwaghela/donate
+
 Integrate your ruby application with this `webceo` gem to perform the api action using your webceo account. Take a look at the [Webceo API Reference](https://www.webceo.com/api-documentation.htm).
 
 ## Getting Started
@@ -21,9 +30,18 @@ Or install it yourself as:
 ## Usage
 
 ```ruby
-# initialize an instance of the Client with your API key or
-# set an Environment Variable WEBCEO_API_KEY and initialize client without passing it to the client
-client = Webceo::Api::Client.new('your_api_key')
+
+# Configure the gem
+Webceo.configure do |config|
+  # set the api_key option as per your convenience, for example using environment variables
+  config.api_key = ENV['WEBCEO_API_KEY']
+end
+
+# initialize an instance of the Client
+client = Webceo::Api::Client.new
+
+# get the list of all methods
+client.list_methods # => ['get_projects', 'get_project', ...]
 
 # get list of all the projects, see api reference
 client.get_projects({ :id => 'my_request_id' })
@@ -37,7 +55,10 @@ client.get_project({ :project => '8ady5y7e36' })
 
 ## Contributing
 
-[![Open Source Helpers](https://www.codetriage.com/agnel/webceo/badges/users.svg)](https://www.codetriage.com/agnel/webceo)
+[![Open Source Helpers](https://www.codetriage.com/agnel/webceo/badges/users.svg)][open_source_helpers]
+![Maintenance](https://img.shields.io/maintenance/yes/2018.svg)
+
+[open_source_helpers]: https://www.codetriage.com/agnel/webceo
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/agnel/webceo. 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.
 
@@ -46,9 +67,15 @@ Check out the [Webceo Ruby Gem Google Group](https://groups.google.com/forum/#!f
 
 ## License
 
+[![license](https://img.shields.io/github/license/agnel/webceo.svg)][mit_license]
+
+[mit_license]: http://opensource.org/licenses/MIT
+
 Webceo is released under the [MIT License](http://opensource.org/licenses/MIT).
 
 ## Todo
 
+- [ ] Configuration Support
+- [ ] Generator for initializer with configuration boilerplate
 - [ ] Batch Operations Support
 - [ ] Specs

data/lib/webceo.rb

@@ -4,9 +4,21 @@ require 'httparty'
 require 'multi_json'
 require 'active_support/core_ext/hash/indifferent_access'
 require 'webceo/api'
-require 'webceo/api/request'
-require 'webceo/api/response'
-require 'webceo/api/error'
-require 'webceo/api/client'
+require 'webceo/configuration'
 
-module Webceo; end # end of module Webceo
+module Webceo
+
+  class << self
+    attr_accessor :configuration
+  end
+
+  def self.configure
+    self.configuration ||= Webceo::Configuration.new
+    yield(configuration)
+  end
+
+  def self.reset
+    self.configuration = Webceo::Configuration.new
+  end
+
+end # end of module Webceo

data/lib/webceo/api.rb

@@ -1,3 +1,8 @@
+require 'webceo/api/request'
+require 'webceo/api/response'
+require 'webceo/api/error'
+require 'webceo/api/client'
+
 module Webceo
 
   API_METHODS = YAML.load_file('./lib/webceo/api_methods.yml')

data/lib/webceo/api/client.rb

@@ -14,13 +14,7 @@ module Webceo
       #
       # Intializes an instance of Client to make api calls
       #
-      # It accepts an api_key or uses the one set in the environment variable WEBCEO_API_KEY
-      #
-      # @param [String] api_key Webceo API Key
-      #
-      def initialize(api_key = nil)
-        self.class.default_options.merge!({ api_key: (api_key || ENV['WEBCEO_API_KEY']) })
-      end
+      def initialize; end
 
       #
       # It lists names of all the available API methods on the Webceo API Reference

data/lib/webceo/api/request.rb

@@ -33,7 +33,7 @@ module Webceo
       def to_json
         MultiJson.dump({
           method: @method_name.to_s,
-          key: Webceo::Api::Client.default_options[:api_key],
+          key: Webceo.configuration.api_key,
           id: @data[:id],
           data: @data
         })

data/lib/webceo/configuration.rb

@@ -0,0 +1,22 @@
+module Webceo
+  #
+  # Class Configuration provides ability to set webceo specific configurations
+  #
+  # @author Agnel Waghela <agnelwaghela@gmail.com>
+  #
+  class Configuration
+
+    #
+    # @!attribute [rw] api_key
+    #   @return [String] API Key required to be present along with the api request
+    attr_accessor :api_key
+
+    #
+    # Initialize default attribute values
+    #
+    #
+    def initialize
+      @api_key = nil
+    end
+  end # end of class Configuration
+end # end of module Webceo

data/lib/webceo/version.rb

@@ -1,17 +1,26 @@
 # frozen_string_literal: true
 
 module Webceo
-  # Returns the version of the currently loaded Rails as a <tt>Gem::Version</tt>
+  #
+  # Returns the version of the currently loaded Webceo as a <tt>Gem::Version</tt>
+  #
   def self.gem_version
     Gem::Version.new VERSION::STRING
   end
 
+  #
+  # Module VERSION provides constants as per the semantic versioning specification
+  #
+  # @see https://semver.org/
+  #
+  # @author Agnel Waghela <agnelwaghela@gmail.com>
+  #
   module VERSION
-    MAJOR = 0
-    MINOR = 1
-    TINY  = 0
+    MAJOR = 1
+    MINOR = 0
+    PATCH = 0
     PRE   = nil # 'alpha', 'beta', 'rc1', 'rc2', nil
 
-    STRING = [MAJOR, MINOR, TINY, PRE].compact.join(".")
+    STRING = [MAJOR, MINOR, PATCH, PRE].compact.join(".")
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: webceo
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Agnel Waghela
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-03-30 00:00:00.000000000 Z
+date: 2018-04-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -150,6 +150,7 @@ files:
 - lib/webceo/api/request.rb
 - lib/webceo/api/response.rb
 - lib/webceo/api_methods.yml
+- lib/webceo/configuration.rb
 - lib/webceo/version.rb
 - webceo.gemspec
 homepage: http://agnelwaghela.in/project/webceo-api-client