any_api 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 3931bd443ce1a3d9701ea5476ef05918700fd9a7
-  data.tar.gz: 08f14997f3102779b09f0598448f68ba37a58d8e
+  metadata.gz: 738ff177c3d4c3d3a5a9de5263708d69657e9fa0
+  data.tar.gz: 251d96c30a9f2b4d21a79fabebffeb20d2cee244
 SHA512:
-  metadata.gz: 627844734297c3bb080eb0194ec922d24a5001c750752ae3deb88393c5c8e002943a1ae4283e0bbe8997c08ef9c75c1aa0ba3f3c95108a97e4ed4fcb8c09ec3a
-  data.tar.gz: 3065622d9b7829c1281249ac7d8e6e49065b5535b029bc09d3d3351b0b41d93ed1f715c6ca4f0055844cadb1b5490bb5b70a52a7ef56edc2878dbd3d69d3b16e
+  metadata.gz: 99e00542da16e16108b47314cb48079d66ff2f9efc8932021c65ecbaad6f89f7f121b63fbd0f0f2acba31190537f7de8d3a669025ad7a198079dae3d4fdb88c7
+  data.tar.gz: 151d3eb3ed2456d022a8158ff8b38525b923388b695d36cce4de8cd01dd749f5e236e5f11b8da3414d4355715d3472ca11109ac8320aad8327b4fbb75e616525

data/README.md

@@ -26,17 +26,18 @@ If you are going to use this with Rails. Add bellow code your application.rb fil
 
 ```ruby
 AnyApi.configure do |config|
+  #please dont put a "/" at the end of the api_base_url
+  config.api_base_url =  "https://iamfree.com/api/v1"
+  #Dont need bellow authentication information if the API does not need username and password  
   config.username =  "me@example.com"
   config.password =  "my-sectret-password"
-  config.api_base_url =  "https://iamfree.com/api/v1"
-  #please dont put a "/" at the end of the api_base_url
 end
 ```
 
 Then you can call any API with  
 
 ```ruby
-response = AnyApi::Request.new("Get", '/products.json' )
+response = AnyApi::Request.new("Get", 'products.json' )
 ```
 
 The first parameter is the HTTP method. Secondly it is the url endpoint.
@@ -46,7 +47,7 @@ If you want to do Post or Update calls please send parameters with your request
 
 ```ruby
 my_params = {"year"=>"2014", "country"=>"Australia", "first_name"=>"True", "last_name"=>"Colours"}
-response = AnyApi::Request.new( "Post", '/users/new', my_params)
+response = AnyApi::Request.new( "Post", 'users/new', my_params)
 ```
 
 To parse the response
@@ -55,6 +56,24 @@ To parse the response
 response.parser_response
 ```
 
+
+If you want assert that the API call is a success before save your information database you could use the is_ok? method
+
+```ruby
+  if response.is_ok?
+    good_json = response.parser_response
+    ......
+  else
+    bad_json_error_message = response.parser_response
+    .....
+  end
+
+
+```
+
+
+
+
 Thanks
 
 

data/lib/any_api.rb

@@ -17,7 +17,7 @@ module AnyApi
       uri = URI.parse("#{AnyApi.configuration.api_base_url}/#{endpoint}")
 
       res = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
-        # a safe eval as only for internal use to give http method - Get, Put, Post, Delete
+        # a safe eval as only  one of the above HTTPMETHODS would be allowed ie: Get, Put, Post, Delete
         request = eval "Net::HTTP::#{http_method if HTTPMETHODS.include?(http_method)}.new uri"
         request.basic_auth(AnyApi.configuration.username, AnyApi.configuration.password)
         request["Content-Type"] = "application/json"
@@ -32,18 +32,31 @@ module AnyApi
 
 
     def parser_response
+      case  apiresult
+        when Net::HTTPSuccess
+          JSON.parse  apiresult.body
+        when Net::HTTPUnauthorized
+          {'error' => "#{ apiresult.message}: username and password set and correct?"}
+        when Net::HTTPServerError
+          {'error' => "#{ apiresult.message}: try again later?"}
+        else
+          {'error' =>  "there seems to be an error in the server, please try again"}
+      end
+    end
+
+
+    def is_ok?
       case  apiresult
       when Net::HTTPSuccess
-        JSON.parse  apiresult.body
-      when Net::HTTPUnauthorized
-        {'error' => "#{ apiresult.message}: username and password set and correct?"}
-      when Net::HTTPServerError
-        {'error' => "#{ apiresult.message}: try again later?"}
+        true
       else
-        {'error' =>  "there seems to be an error in the server, please try again"}
+        false
       end
+
     end
-  end
 
 
+
+    end
+
 end

data/lib/any_api/configuration.rb

@@ -3,9 +3,9 @@ module AnyApi
     attr_accessor :username, :password, :api_base_url, :log_level
 
     def initialize
+      self.api_base_url = nil
       self.username =  nil
       self.password =  nil
-      self.api_base_url = nil
       self.log_level = 'info'
     end
   end

data/lib/any_api/version.rb

@@ -1,3 +1,3 @@
 module AnyApi
-  VERSION = "0.0.2"
+  VERSION = "0.0.3"
 end

data/test/any_api_test.rb

@@ -4,12 +4,24 @@ class AnyApiTest < Minitest::Test
 
 
   def test_connection
-     response = AnyApi::Request.new( "Get", '/tickets.json')
+     response = AnyApi::Request.new( "Get", 'tickets.json')
       #p response
       #p response.apiresult.body
       p response.parser_response
+
       assert_equal  "200", response.apiresult.code
+      assert response.is_ok?
    end
 
 
+   def test_faliour
+
+     AnyApi.configure do |config|
+       config.api_base_url =  "https://iamfree.com/api/v1"
+     end
+     response = AnyApi::Request.new( "Get", 'hello.json')
+     p response.parser_response
+     refute response.is_ok? 
+   end
+
 end

data/test/test_helper.rb

@@ -14,8 +14,7 @@ require_relative "../lib/any_api"
 secretfile = YAML.load_file("#{Dir.pwd}/test/fixtures/secrets.yml")
 
 AnyApi.configure do |config|
+  config.api_base_url =  secretfile["conf"]["api_base_url"]
   config.username =  secretfile["conf"]["username"]
   config.password =  secretfile["conf"]["password"]
-  config.api_base_url =  secretfile["conf"]["api_base_url"]
-
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: any_api
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - anthony
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-12-09 00:00:00.000000000 Z
+date: 2014-12-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler