Skip to content

Commit

Permalink
MinIO & min.io replaces Minio & minio.io respectively (#114)
Browse files Browse the repository at this point in the history
  • Loading branch information
ebozduman authored and krisis committed Apr 12, 2019
1 parent 82bb601 commit af3b75e
Show file tree
Hide file tree
Showing 58 changed files with 127 additions and 127 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@ This release brings the following changes:
This is a bug-fix release:

* Fix concurrency bug in `limitedMapConcurrently` (#53)
* Fix tests related to listing incomplete uploads to accommodate Minio
* Fix tests related to listing incomplete uploads to accommodate MinIO
server's changed behaviour to not list incomplete uploads. Note that
running these tests against AWS S3 are expected to fail. (#54)

Expand Down
16 changes: 8 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Minio Client SDK for Haskell [![Build Status](https://travis-ci.org/minio/minio-hs.svg?branch=master)](https://travis-ci.org/minio/minio-hs)[![Hackage](https://img.shields.io/hackage/v/minio-hs.svg)](https://hackage.haskell.org/package/minio-hs)[![Slack](https://slack.minio.io/slack?type=svg)](https://slack.minio.io)
# MinIO Client SDK for Haskell [![Build Status](https://travis-ci.org/minio/minio-hs.svg?branch=master)](https://travis-ci.org/minio/minio-hs)[![Hackage](https://img.shields.io/hackage/v/minio-hs.svg)](https://hackage.haskell.org/package/minio-hs)[![Slack](https://slack.min.io/slack?type=svg)](https://slack.min.io)

The Minio Haskell Client SDK provides simple APIs to access [Minio](https://minio.io) and Amazon S3 compatible object storage server.
The MinIO Haskell Client SDK provides simple APIs to access [MinIO](https://min.io) and Amazon S3 compatible object storage server.

## Minimum Requirements

Expand All @@ -24,10 +24,10 @@ stack test

```

A section of the tests use the remote Minio Play server at
`https://play.minio.io:9000` by default. For library development,
A section of the tests use the remote MinIO Play server at
`https://play.min.io:9000` by default. For library development,
using this remote server maybe slow. To run the tests against a
locally running Minio live server at `http://localhost:9000`, just set
locally running MinIO live server at `http://localhost:9000`, just set
the environment `MINIO_LOCAL` to any value (and unset it to switch
back to Play).

Expand All @@ -47,7 +47,7 @@ stack haddock
-- stack --resolver lts-11.1 runghc --package minio-hs --package optparse-applicative --package filepath

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -76,7 +76,7 @@ import UnliftIO (throwIO, try)
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand All @@ -86,7 +86,7 @@ import Prelude
fileNameArgs :: Parser FilePath
fileNameArgs = strArgument
(metavar "FILENAME"
<> help "Name of file to upload to AWS S3 or a Minio server")
<> help "Name of file to upload to AWS S3 or a MinIO server")

cmdParser = info
(helper <*> fileNameArgs)
Expand Down
2 changes: 1 addition & 1 deletion Setup.hs
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
--
-- Minio Haskell SDK, (C) 2017 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand Down
50 changes: 25 additions & 25 deletions docs/API.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# Minio Haskell SDK API Reference
# MinIO Haskell SDK API Reference

## Initialize Minio Client object.
## Initialize MinIO Client object.

### Minio - for public Play server
### MinIO - for public Play server

```haskell
minioPlayCI :: ConnectInfo
Expand Down Expand Up @@ -32,8 +32,8 @@ awsCI { connectAccesskey = "your-access-key"

## 1. Connecting and running operations on the storage service

The Haskell Minio SDK provides high-level functionality to perform
operations on a Minio server or any AWS S3-like API compatible storage
The Haskell MinIO SDK provides high-level functionality to perform
operations on a MinIO server or any AWS S3-like API compatible storage
service.

### The `ConnectInfo` type
Expand Down Expand Up @@ -77,18 +77,18 @@ The parameters in the expression `awsWithRegion region autoDiscover` are:
#### minioPlayCI :: ConnectInfo

This constructor provides connection and authentication information to
connect to the public Minio Play server at
`https://play.minio.io:9000/`.
connect to the public MinIO Play server at
`https://play.min.io:9000/`.

#### minioCI :: Text -> Int -> Bool -> ConnectInfo

Use to connect to a Minio server.
Use to connect to a MinIO server.

The parameters in the expression `minioCI host port isSecure` are:

|Parameter|Type|Description|
|:---|:---|:---|
| `host` | _Text_ | Hostname of the Minio or other S3-API compatible server |
| `host` | _Text_ | Hostname of the MinIO or other S3-API compatible server |
| `port` | _Int_ | Port number to connect to|
| `isSecure` | _Bool_ | Does the server use HTTPS? |

Expand All @@ -112,7 +112,7 @@ values.
### The Minio Monad

This monad provides the required environment to perform requests
against a Minio or other S3 API compatible server. It uses the
against a MinIO or other S3 API compatible server. It uses the
connection information from the `ConnectInfo` value provided to it. It
performs connection pooling, bucket location caching, error handling
and resource clean-up actions.
Expand Down Expand Up @@ -264,8 +264,8 @@ import Conduit
import Prelude


-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand All @@ -277,7 +277,7 @@ main = do
bucket = "test"

-- Performs a recursive listing of all objects under bucket "test"
-- on play.minio.io.
-- on play.min.io.
res <- runMinio minioPlayCI $
runConduit $ listObjects bucket Nothing True .| mapM_C (\v -> (liftIO $ print v))
print res
Expand Down Expand Up @@ -325,8 +325,8 @@ import Conduit
import Prelude


-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand All @@ -338,7 +338,7 @@ main = do
bucket = "test"

-- Performs a recursive listing of all objects under bucket "test"
-- on play.minio.io.
-- on play.min.io.
res <- runMinio minioPlayCI $
runConduit $ listObjectsV1 bucket Nothing True .| mapM_C (\v -> (liftIO $ print v))
print res
Expand Down Expand Up @@ -383,8 +383,8 @@ import Network.Minio
import Conduit
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand All @@ -396,7 +396,7 @@ main = do
bucket = "test"

-- Performs a recursive listing of incomplete uploads under bucket "test"
-- on a local minio server.
-- on a local MinIO server.
res <- runMinio minioPlayCI $
runConduit $ listIncompleteUploads bucket Nothing True .| mapM_C (\v -> (liftIO $ print v))
print res
Expand Down Expand Up @@ -450,8 +450,8 @@ import qualified Data.Conduit.Binary as CB

import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down Expand Up @@ -500,8 +500,8 @@ import qualified Data.Conduit.Combinators as CC

import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down Expand Up @@ -560,8 +560,8 @@ import Data.Conduit (($$+-))
import Data.Conduit.Binary (sinkLbs)
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- | The following example uses MinIO play server at
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down
4 changes: 2 additions & 2 deletions examples/BucketExists.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,7 @@ import Control.Monad.IO.Class (liftIO)
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down
4 changes: 2 additions & 2 deletions examples/CopyObject.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,7 @@ import Control.Monad.Catch (catchIf)
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down
6 changes: 3 additions & 3 deletions examples/FileUploader.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs --package optparse-applicative --package filepath

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -31,7 +31,7 @@ import UnliftIO (throwIO, try)
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand All @@ -41,7 +41,7 @@ import Prelude
fileNameArgs :: Parser FilePath
fileNameArgs = strArgument
(metavar "FILENAME"
<> help "Name of file to upload to AWS S3 or a Minio server")
<> help "Name of file to upload to AWS S3 or a MinIO server")

cmdParser = info
(helper <*> fileNameArgs)
Expand Down
2 changes: 1 addition & 1 deletion examples/GetConfig.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/GetObject.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand All @@ -26,7 +26,7 @@ import qualified Data.Conduit.Binary as CB
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down
4 changes: 2 additions & 2 deletions examples/HeadObject.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,7 @@ import Network.Minio.S3API
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down
2 changes: 1 addition & 1 deletion examples/Heal.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand Down
4 changes: 2 additions & 2 deletions examples/ListBuckets.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,7 @@ import Control.Monad.IO.Class (liftIO)
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand Down
6 changes: 3 additions & 3 deletions examples/ListIncompleteUploads.hs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
-- stack --resolver lts-11.1 runghc --package minio-hs

--
-- Minio Haskell SDK, (C) 2017, 2018 Minio, Inc.
-- MinIO Haskell SDK, (C) 2017, 2018 MinIO, Inc.
--
-- Licensed under the Apache License, Version 2.0 (the "License");
-- you may not use this file except in compliance with the License.
Expand All @@ -24,7 +24,7 @@ import Conduit
import Prelude

-- | The following example uses minio's play server at
-- https://play.minio.io:9000. The endpoint and associated
-- https://play.min.io:9000. The endpoint and associated
-- credentials are provided via the libary constant,
--
-- > minioPlayCI :: ConnectInfo
Expand All @@ -42,7 +42,7 @@ main = do
print res

{-
Following is the output of the above program on a local Minio server.
Following is the output of the above program on a local MinIO server.
Right [UploadInfo { uiKey = "go1.6.2.linux-amd64.tar.gz"
, uiUploadId = "063eb592-bdd7-4a0c-be48-34fb3ceb63e2"
Expand Down
Loading

0 comments on commit af3b75e

Please sign in to comment.