fog-akamai 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0fd6496beeb81adaf17b9c531670a5fc4d29cbd6
-  data.tar.gz: 17398769af5612dbfbc314845a84feced0843552
+  metadata.gz: f8e1c183618f068be64f0d0959e390b23b19b46f
+  data.tar.gz: cdb9cd220be1caff79b65c156aa6754fb75b7fde
 SHA512:
-  metadata.gz: 95ab846e7491dfd361f61ab744641efd98c2401f5c9f4b296cbc8d058bcad4caad01b3401e3574288b49c4ff970e89ff7ab63177bcbf6a8541d29da83628070f
-  data.tar.gz: 02df2e86430f927c848b427075af5e8327730ff41a15795242afb6ebe0890465b9ebd82fac9d679bb92edb442b1150bc4c400bc1116ea0807f8fc5f62dd26507
+  metadata.gz: 5197933b51c297b44232851ce28e99ba5911019ed43db5f4de44b7907c327f1fe4a70a85ba1b59bdd510e2239bbb830b666aaf8be235216fb85eaf8c454e66f9
+  data.tar.gz: fc093806a9fd762caddce13ad6f6796f5a05dbd857097d0f77fb8744a99cd04cd2d1d565d5ae8477db05d140f303eda50d37c2e996647f1c23456fbf2a1d1e07

data/README.md

@@ -1,8 +1,8 @@
-# Fog::Storage
+# Fog Akamai
 
 Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/fog/storage`. To experiment with that code, run `bin/console` for an interactive prompt.
 
-TODO: Delete this and the text above, and describe your gem
+This is still under development only very basic net storage functionality has been put in place.
 
 ## Installation
 
@@ -22,7 +22,53 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+Before you can use fog-akamai, you must require it in your application:
+
+```ruby
+require 'fog/aws'
+```
+
+Since it's a bad practice to have your credentials in source code, you should load them from default fog configuration file: ```~/.fog```. This file could look like this:
+
+```
+default:
+  akamai_host:     <YOUR_AKAMAIHOST>
+  akamai_key_name: <YOUR_KEY_NAME>
+  akamai_key:      <YOU_KEY>
+  akamai_cp_code:  <YOU_CP_CODE>
+```
+
+You can get more detail about how to obtain this credential form [this doc](https://control.akamai.com/dl/customers/NS/NS_Config_FS.pdf)
+
+### Connecting to NetStorage service
+
+```ruby
+net_storage = Fog::Compute.new :provider => 'akamai'
+```
+
+### To get a directory:
+
+```ruby
+directory = net_storage.directories.get('/path')
+```
+
+### To check if a file exists:
+
+```ruby
+directory.files.stat('file.ext')
+```
+
+### To upload a file:
+
+```ruby
+directory.files.create(directory: directory, body: file_body, key: file_name)
+```
+
+## Roadmap
+
+- finish implementing the netstorage api
+- add mock support
+- implement ccu api
 
 ## Development
 

data/lib/fog/akamai/storage.rb

@@ -27,6 +27,8 @@ module Fog
       end
 
       class Mock
+        def initialize(_options = {})
+        end
       end
 
       class Real

data/lib/fog/akamai/version.rb

@@ -1,5 +1,5 @@
 module Fog
   module Akamai
-    VERSION = "0.1.0"
+    VERSION = '0.1.1'
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fog-akamai
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Calin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-11-04 00:00:00.000000000 Z
+date: 2015-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -192,7 +192,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.8
+rubygems_version: 2.4.6
 signing_key: 
 specification_version: 4
 summary: Module for 'fog' gem to support Akamai