easybill-api 0.7.0 → 0.7.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 248667940e7669f77cbfb550702bb30bd0ab79b1
-  data.tar.gz: dd1131db72ba0a6aa8450b1b1db2b55b6267f66e
+  metadata.gz: a9fbb2b594d462f64e79bb212a2c0175a6a031ab
+  data.tar.gz: c4d555d86a682613005cc535b243653b3a6b4b2e
 SHA512:
-  metadata.gz: 04e9257af421c8d99a472fda6b4a0ce3a5fac8b4a2168df4564b888b0c71cc184340c3599f40abc30fbabbdcf9f531ee622c2404479263ab62d72826c8ef6942
-  data.tar.gz: e7fa8ecc3bc1a4abd8274373355f76752a155c36915e71891f70c7a9cc23550ec979e077d54d82ea36280216af9a5abda3632d0f60b1477c8be66e0d4f39fe40
+  metadata.gz: 201e827dab9e7318700b08f42862cf6771a8c118401cc033f819c06eb35923aab6786487fb2839455228da7d546e63fb1d07f04828e65680df312bf7f380df1d
+  data.tar.gz: 84391415d0eea401203523f9267a69702ab55996eed0928db2af7576dc13b79adcf5feed31bf949b0bfd1019f77b1071065f0acf08133ca9a7e19ef4fc271e94

data/README.md

@@ -20,21 +20,57 @@ Or install it yourself as:
 
 ## Usage
 
-
 Initialize a new api client:
 
 ```
 @api = Easybill::Api.new(<YOUR API TOKEN>)
 ```
 
+Example calls based on the `customers` resource:
+
+```
+# Fetch all customers
+
+customers = @api.customers.list["items"]
+```
+
+```
+# Fetch one customers
+
+customer = @api.customers.find(<ID>)
+fist_name = response["first_name"]
+```
+
 ```
-@api.customers.list
-=> Fetch all customers
+# Create a customer
+
+customer_hash = {
+  first_name: "fabio",
+  last_name: "lorenzo",
+  ...
+}
+
+customer = @api.customers.create(customer_hash)
+# => 201 created
 ```
 
 ```
-@api.customers.find(<ID>)
-=> Fetch one customers
+# Update a customer
+
+update_customer_hash = {
+  country: "UK",
+  ...
+}
+
+customer = @api.customers.update(<ID>, update_customer_hash)
+# => 200 ok
+```
+
+```
+# Delete a customer
+
+@api.customers.destroy(<ID>)
+# => 204 deleted
 ```
 
 ## Development

data/lib/easybill/api/base.rb

@@ -2,6 +2,18 @@ require 'httparty'
 
 module Easybill
   module Api
+
+    ##
+    # The base class for all Easybill entities.
+    # Set the authorization header before using it via `.authenticate`
+    #
+    # Sets the default headers:
+    # "User-Agent"   => "Ruby.Easybill.Api",
+    # "Accept"       => "application/json",
+    # "Content-Type" => "application/json"
+    #
+    # Provides the basic interface. Such as list, find, create, update, destroy
+
     class Base
       include HTTParty
 
@@ -16,30 +28,68 @@ module Easybill
       format :json
 
       class << self
-        def authenticate!(api_key)
+
+        ##
+        # Set the authorization header by providing your easybill +api_key+
+
+        def authenticate(api_key)
           headers["authorization"] = "Bearer #{api_key}"
         end
 
+        ##
+        # Fetches all resources. You can set custom +query+ parameters.
+
         def list(query: {})
           get resource_path, query: query
         end
 
+        ##
+        # Fetches a resource by its +id+. You can set custom +query+ parameters.
+        # api.find(id, query: {group: 1})
+
         def find(id, query: {})
           get "#{resource_path}/#{id}", query: query
         end
 
+        ##
+        # Creates a resource. Provide the +data+ as a hash.
+        # e.g.
+        # data = {
+        #   first_name: "Lars",
+        #   last_name: "Bar",
+        #   ...
+        # }
+        # api.create(data)
+
         def create(data)
           post resource_path, body: data.to_json
         end
 
+        ##
+        # Updates a resource. Provide the +id+ and +data+.
+        # e.g.
+        # id = 123456
+        # data = {
+        #   first_name: "Lars",
+        #   last_name: "Bar",
+        #   ...
+        # }
+        # api.update(id, data)
+
         def update(id, data)
           put "#{resource_path}/#{id}", body: data.to_json
         end
 
+        ##
+        # Destroys a resource. Provide the +id+.
+        # api.destroy(id)
+
         def destroy(id)
           delete "#{resource_path}/#{id}"
         end
 
+        protected
+
         def custom(method:, path:, query: {}, data: {}, headers: {})
           request_options = {}
 
@@ -60,6 +110,7 @@ module Easybill
           "#{base_path}/#{dasherize(self.name.split("::").last)}"
         end
 
+        # TODO-schnika: move this out of here Oo
         def dasherize(camel_cased_word)
           camel_cased_word.to_s.gsub(/::/, '/').
           gsub(/([A-Z]+)([A-Z][a-z])/,'\1_\2').

data/lib/easybill/api/client.rb

@@ -1,58 +1,109 @@
 module Easybill
   module Api
+
+    ##
+    # This class represents the client object.
+    # Use this class to initialize you api client
+
     class Client
+
+      ##
+      # Create a new client instance with an +api_key+
+      #
+      # Create or use your generated easybill +api_key+ here
+      # @api = Easybill::Api::Client.new("api_key")
+
       def initialize(api_key)
-        Easybill::Api::Base.authenticate! api_key
+        Easybill::Api::Base.authenticate api_key
       end
 
+      ##
+      # Returns a Easybill::Api::Attachments class
+
       def attachments
         Easybill::Api::Attachments
       end
 
+      ##
+      # Returns a Easybill::Api::Contacts class
+
       def contacts
         Easybill::Api::Contacts
       end
 
+      ##
+      # Returns a Easybill::Api::CustomerGroups class
+
       def customer_groups
         Easybill::Api::CustomerGroups
       end
 
+      ##
+      # Returns a Easybill::Api::Customers class
+
       def customers
         Easybill::Api::Customers
       end
 
+      ##
+      # Returns a Easybill::Api::DocumentPayments class
+
       def document_payments
         Easybill::Api::DocumentPayments
       end
 
+      ##
+      # Returns a Easybill::Api::Documents class
+
       def documents
         Easybill::Api::Documents
       end
 
+      ##
+      # Returns a Easybill::Api::PositionGroups class
+
       def position_groups
         Easybill::Api::PositionGroups
       end
 
+      ##
+      # Returns a Easybill::Api::Positions class
+
       def positions
         Easybill::Api::Positions
       end
 
+      ##
+      # Returns a Easybill::Api::PostBoxes class
+
       def post_boxes
         Easybill::Api::PostBoxes
       end
 
+      ##
+      # Returns a Easybill::Api::Projects class
+
       def projects
         Easybill::Api::Projects
       end
 
+      ##
+      # Returns a Easybill::Api::Tasks class
+
       def tasks
         Easybill::Api::Tasks
       end
 
+      ##
+      # Returns a Easybill::Api::TextTemplates class
+
       def text_templates
         Easybill::Api::TextTemplates
       end
 
+      ##
+      # Returns a Easybill::Api::TimeTrackings class
+
       def time_trackings
         Easybill::Api::TimeTrackings
       end

data/lib/easybill/api/version.rb

@@ -1,5 +1,5 @@
 module Easybill
   module Api
-    VERSION = "0.7.0"
+    VERSION = "0.7.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: easybill-api
 version: !ruby/object:Gem::Version
-  version: 0.7.0
+  version: 0.7.1
 platform: ruby
 authors:
 - Patrick Schnetger