rapidapi 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 01b14bc1e880d4594f2b67229d36bc10eb278926
-  data.tar.gz: 40f5aa9ebe55980f05d01773c530a915dafa059f
+  metadata.gz: 1ce57a28128fe74a9719ed9c6b25952ab8ea6ea2
+  data.tar.gz: 2b3235bae870282e102046d24596fd72e24829d0
 SHA512:
-  metadata.gz: 94d36fe4917b65a016453bd1dc4d5219fe09cc3a7907a51eb16983edc8e21778fa08d238198fefd2348684525335c2fd2b0f93b1c8c0dbc28e53e57c2c7bd74a
-  data.tar.gz: 762de32d4dd3b08021a037c30f082f11d492fc9d761ba7fd32cc66b0ae680d163510f10ae338416e2b57615002dd30bac57cf9137eb3f25e8feea0cac143223f
+  metadata.gz: 66ce83fe19adf4e8397a4b99f04d2236ca35ddbd8add5c65419bceebacda932a3add7181d4c91e6a1265fd0d7d5a7894a0988fbf9d88be75c967776f68a2607b
+  data.tar.gz: 8079069621d353646a7aabdeed66ff07b20e59febec1018c5ad877d94c47458cf8253e465728ee97893f302ac19340e31dd2beb1530e7516ae124d933c7c2da2

data/README.md

@@ -0,0 +1,99 @@
+<p align="center">
+  <img src="https://storage.googleapis.com/rapid_connect_static/static/github-header.png" width=350 />
+</p>
+
+## Overview
+RapidAPI is the world's first opensource API marketplace. It allows developers to discover and connect to the world's top APIs more easily and manage multiple API connections in one place.
+
+## iOS SDK
+* In case you're using [CocoaPods](https://cocoapods.org), add the following line to your `Podfile`:
+
+  ```ruby
+  pod "RapidAPISDK", "~> 0.1"
+  ```
+  
+* Otherwise, you can add RapidAPISDK manually to your Xcode project.
+  1. Go to the [releases tab](https://github.com/RapidSoftwareSolutions/rapidapi-ios-sdk/releases).
+  2. Download the latest release zip.
+  3. Unzip the file and drag the *RapidConnectSDK.framework* directory to the "Frameworks" folder in your project.  
+
+## Initialization
+Import RapidAPISDK by putting the following code in your header file
+
+  ```objective-c
+  #import <RapidConnectSDK/RapidConnectSDK.h>
+  ```
+    
+Now initialize it using:
+    
+  ```objective-c
+  RapidConnect *rapid = [[RapidConnect alloc] initWithProjectName:@"PROJECT_NAME" andToken:@"TOKEN"];
+  ```
+## Usage
+To use any block in the marketplace, just copy it's code snippet and paste it in your code. For example, the following is the snippet for the **Delivery.sendSMS** block:
+
+  ```objective-c
+    [rapid callPackage:@"Delivery" block:@"sendSMS"
+        withParameters:[NSDictionary dictionaryWithObjectsAndKeys:
+                        @"Hello from RapidAPI!",@"message",
+                        @"4158496404", @"number",
+                        nil]
+               success:^(NSDictionary *responseDict) {
+               
+               // response handling here ...
+               NSLog(@"%@",responseDict);
+               
+    } failure:^(NSError *error) {
+        // error handling here ...
+        NSLog(@"%@",[error localizedDescription]);
+  ```
+
+
+**Notice** that the `error` event will also be called if you make an invalid block call (for example - the package you refer to does not exist).
+
+## Using Files
+Whenever a block in RapidAPI requires a file, you can either pass a URL to the file or a read stream.
+
+#### URL
+The following code will call the block MicrosoftComputerVision.analyzeImage with a URL of an image:
+
+  ```objective-c    
+    [rapid callPackage:@"MicrosoftComputerVision" block:@"analyzeImage"
+        withParameters:[NSDictionary dictionaryWithObjectsAndKeys:
+                        @"XXXXXXXXXXXXXXXXXXX",@"subscriptionKey",
+                        @"http://example.com/file.jpg", @"image",
+                        nil]
+               success:^(NSDictionary *responseDict) {
+        NSLog(@"%@",responseDict);
+    } failure:^(NSError *error) {
+        // error handling here ...
+        NSLog(@"%@",[error localizedDescription]);
+  ```
+
+#### Post File
+If the file is locally stored, you can read it using `NSFileManager` and pass the read stream to the block, like the following:
+
+  ```objective-c 
+    NSData *data = [[NSFileManager defaultManager] contentsAtPath:@"path/to/the/file.jpg"];
+    
+    [rapid callPackage:@"MicrosoftComputerVision" block:@"analyzeImage"
+        withParameters:[NSDictionary dictionaryWithObjectsAndKeys:
+                        @"XXXXXXXXXXXXXXXXXXX",@"subscriptionKey",
+                        data, @"image",
+                        nil]
+               success:^(NSDictionary *responseDict) {
+        NSLog(@"%@",responseDict);
+    } failure:^(NSError *error) {
+        // error handling here ...
+        NSLog(@"%@",[error localizedDescription]);
+  ```
+        
+##Issues:
+
+As this is a pre-release version of the SDK, you may expirience bugs. Please report them in the issues section to let us know. You may use the intercom chat on rapidapi.com for support at any time.
+
+##License:
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/rapidapi/config.rb

@@ -6,7 +6,7 @@ end
 class RapidAPI::Config
   def self.setup(**args)
     @@project = args[:project]
-    @@api_key = args[:api_key]
+    @@token = args[:token]
     return
   end
 
@@ -14,7 +14,7 @@ class RapidAPI::Config
     @@project || raise(MissingCredentialsError, 'Project name not set')
   end
 
-  def self.api_key
-    @@api_key || raise(MissingCredentialsError, 'API key not set')
+  def self.token
+    @@token || raise(MissingCredentialsError, 'Token not set')
   end
 end

data/lib/rapidapi/version.rb

@@ -1,3 +1,3 @@
 module RapidAPI
-  VERSION = '0.1.1'
+  VERSION = '0.1.2'
 end

data/lib/rapidapisdk.rb

@@ -36,7 +36,7 @@ module RapidAPI
       config = RapidAPI::Config
 
       req = Net::HTTP::Post::Multipart.new(uri, form_data)
-      req.basic_auth(config.project, config.api_key)
+      req.basic_auth(config.project, config.token)
 
       req
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: rapidapi
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Andrey Bukati