pinch-api 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3847478d602a0b7ba7d315279b6501e46dbf05fc
-  data.tar.gz: 7fa3b4f0e62309c6cd2dd48179c609f1ab9058db
+  metadata.gz: f3a56ab8e7b4a92cff65468ddc3e83273bf451b0
+  data.tar.gz: c3ee564b18ae9b5f8739520e02772c1d40044df4
 SHA512:
-  metadata.gz: 6025eea1563e0011bd82289a803965b43ec8f56de85d7dcb62b73722d6c2bf6f922ad361cccfa5a84407e3e7ffb78099b284d271eec84c355c5c86b45954f7c2
-  data.tar.gz: c3ea6842853b29a0bfe2a79920233a6bfc108a9f208dd6c9708b72775cad4df8c7421eaace36272a0f7ead67e614ba3911d9a8e881321b1b97cfe94465275723
+  metadata.gz: 1f20f99d667ce97943f713d3339a041b6c9d036ba5660812e65943c0e6bd161326797bb6307c0abb4ede58f13a5ca7cdf53b3466f4abdd8bb767a38748f7ea25
+  data.tar.gz: fbcd8238d7550ab1ea64da15b021e58334a8e6ec05d0c53012b7b83b84b0547ea450a7a10f1b628bd5ad8dd8f7bf32d94acc899d6fbc1c248f06b1c30b95df1e

data/README.md

@@ -1,48 +1,32 @@
 Pinch
 =================
-This API SDK was automatically generated by APIMATIC v2.0
 
-How To Configure:
-=================
-The generated code might need to be configured with your API credentials. To do that,
-open the file "configuration.rb" and edit it's contents.
-
-Alternatively, you can modify the Configuration parameters at run-time through the following
-```
-Pinch::Configuration.your_paramater=YOUR_VALUE
-```
+## Installation
 
-How To Build: 
-=============
-The generated code uses a Ruby gem namely 'unirest'. The reference to this gem is
-already added in the gemspec. Therefore, you will need internet access to resolve
-this dependency.
+To install this gem, simply type :
+`gem install pinch`
 
-How To Use:
-===========
-The generated code can be used to build gem, which can then be distributed online.
-Otherwise, you can include the generated code in your project to use directly.
+You can also add it to a gemfile :
+`gem 'pinch'`
 
-Use the following steps to build a gem and use locally
+Finally, if you wish to use the head version, you can specify the github master branch :
+`gem pinch, github: 'Inchdev/pinch-ruby'`
 
-    1. Run the build command
-        ```
-        gem build pinch.gemspec
-        ```
-
-    2. Run the install command  
-        ```
-        gem install ./pinch-1.0.gem
-        ```
-
-    3. In your Gemfile add this line
-        ```
-        gem 'pinch', '~> 1.0'
-        ```
+## Configuration
+There is 2 different ways of authenticating yourself, either from an initializer file :
+```ruby
+# config/initializers/pinch.rb
+require 'pinch'
+Pinch::Configuration.x_api_token = 'MY_API_KEY'
+# or the recommended way
+Pinch::Configuration.x_api_token = ENV['PINCH_API_KEY']
+```
 
-    4. Now create an instance and use the instance methods, like following.
+Or directly before you want to perform a query :
+```ruby
+require 'pinch'
+pinch = Pinch::PinchClient.new(x_api_token: "MY_API_KEY", x_api_email: "myemail@example.com")
+```
 
-        ```
-        ctl = Pinch::WebhookTypeController.new params
-        ctl.list params
-        ```
+## Usage
+For further documentation, please refer to [the documentation website](http://doc-company.inchbase.com/?ruby)

data/lib/pinch/configuration.rb

@@ -6,10 +6,10 @@ module Pinch
     @base_uri = 'https://api-company.inchbase.com/api/v1'
 
     # Your api key
-    @x_api_token = TODO: Replace
+    @x_api_token = nil
 
     # Your registered email
-    @x_api_email = TODO: Replace
+    @x_api_email = nil
 
     # create the getters and setters
     class << self

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: pinch-api
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Inchdev
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-05-13 00:00:00.000000000 Z
+date: 2016-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: unirest